StatSignaturesApi.md

esp_sdk.StatSignaturesApi

All URIs are relative to https://api.evident.io

Method	HTTP request	Description
list_for_stat	GET /api/v2/stats/{stat_id}/signatures.json_api	Get a list of statistics for signatures
show	GET /api/v2/stats/signatures/{id}.json_api	Show a single Stat Signature

list_for_stat

PaginatedCollection list_for_stat(stat_id, include=include, filter=filter, page=page)

Get a list of statistics for signatures

A successful call to this API returns all the statistics of all the signatures for a report identified by the stat_id parameter. Said report contains all statistics for this alert triggered from signatures contained in all signatures for the selected hour.

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.StatSignaturesApi()
stat_id = 56 # int | The ID of the stat to retrieve signature statistics for
include = 'include_example' # str | Related objects that can be included in the response:  signature, stat See Including Objects for more information. (optional)
filter = {'key': 'filter_example'} # dict(str, str) | Filter Params for Searching.  Equality Searchable Attributes: [stat_id, type_id]     (optional)
page = '{:number=>1,+:size=>20}' # str | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page. (optional) (default to {:number=>1,+:size=>20})

try: 
    # Get a list of statistics for signatures
    api_response = api_instance.list_for_stat(stat_id, include=include, filter=filter, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatSignaturesApi->list_for_stat: %s\n" % e)

Parameters

Name	Type	Description	Notes
stat_id	int	The ID of the stat to retrieve signature statistics for
include	str	Related objects that can be included in the response: signature, stat See Including Objects for more information.	[optional]
filter	dict(str, str)	Filter Params for Searching. Equality Searchable Attributes: [stat_id, type_id]	[optional]
page	str	Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page.	[optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show

StatSignature show(id, include=include)

Show a single Stat Signature

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.StatSignaturesApi()
id = 56 # int | Stat Signature ID
include = 'include_example' # str | Related objects that can be included in the response:  signature, stat See Including Objects for more information. (optional)

try: 
    # Show a single Stat Signature
    api_response = api_instance.show(id, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatSignaturesApi->show: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stat Signature ID
include	str	Related objects that can be included in the response: signature, stat See Including Objects for more information.	[optional]

Return type

StatSignature

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]