StatRegionsApi.md

StatRegionsApi

All URIs are relative to http://localhost/

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

listForStat

PaginatedCollection listForStat(statId, include, filter, page)

Get a list of statistics for regions

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

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.StatRegionsApi;


StatRegionsApi apiInstance = new StatRegionsApi();
Integer statId = 56; // Integer | The ID of the stat to retrieve region statistics for
String include = "include_example"; // String | Related objects that can be included in the response:  region, stat See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [stat_id, type_id]    
String page = "{:number=>1,+:size=>20}"; // String | 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.
try {
    PaginatedCollection result = apiInstance.listForStat(statId, include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StatRegionsApi#listForStat");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
statId	Integer	The ID of the stat to retrieve region statistics for
include	String	Related objects that can be included in the response: region, stat See Including Objects for more information.	[optional]
filter	Map<String, String>	Filter Params for Searching. Equality Searchable Attributes: [stat_id, type_id]	[optional]
page	String	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

No authorization required

HTTP request headers

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

show

StatRegion show(id, include)

Show a single Stat Region

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.StatRegionsApi;


StatRegionsApi apiInstance = new StatRegionsApi();
Integer id = 56; // Integer | Stat Region ID
String include = "include_example"; // String | Related objects that can be included in the response:  region, stat See Including Objects for more information.
try {
    StatRegion result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StatRegionsApi#show");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer	Stat Region ID
include	String	Related objects that can be included in the response: region, stat See Including Objects for more information.	[optional]

Return type

StatRegion

Authorization

No authorization required

HTTP request headers

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