StatsApi.md

StatsApi

All URIs are relative to http://localhost/

Method	HTTP request	Description
forReport	GET api/v2/reports/{report_id}/stats.json_api	Stats for a report
latestForTeams	PUT api/v2/stats/latest_for_teams.json_api	Statistics for teams
show	GET api/v2/stats/{id}.json_api	Show a single Stat

forReport

Stat forReport(reportId, include)

Stats for a report

A successful call to this API returns all the stats of all the alerts for a report identified by the report_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.StatsApi;


StatsApi apiInstance = new StatsApi();
Integer reportId = 56; // Integer | The ID of the report to retrieve stats for
String include = "include_example"; // String | Related objects that can be included in the response:  report, regions, services, signatures, custom_signatures, custom_compliance_controls, compliance_controls See Including Objects for more information.
try {
    Stat result = apiInstance.forReport(reportId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StatsApi#forReport");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
reportId	Integer	The ID of the report to retrieve stats for
include	String	Related objects that can be included in the response: report, regions, services, signatures, custom_signatures, custom_compliance_controls, compliance_controls See Including Objects for more information.	[optional]

Return type

Stat

Authorization

No authorization required

HTTP request headers

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

latestForTeams

PaginatedCollection latestForTeams(include, filter, page)

Statistics for teams

A successful call to this API returns all the statistics for the most recent report of each team accessible by the given API key

Example

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


StatsApi apiInstance = new StatsApi();
String include = "include_example"; // String | Related objects that can be included in the response:  report, regions, services, signatures, custom_signatures, custom_compliance_controls, compliance_controls See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.      Searchable Association: [report] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
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.latestForTeams(include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StatsApi#latestForTeams");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
include	String	Related objects that can be included in the response: report, regions, services, signatures, custom_signatures, custom_compliance_controls, compliance_controls See Including Objects for more information.	[optional]
filter	Map<String, String>	Filter Params for Searching. Searchable Association: [report] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.	[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

Stat show(id, include)

Show a single Stat

Example

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


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

Parameters

Name	Type	Description	Notes
id	Integer	Stat ID
include	String	Related objects that can be included in the response: report, regions, services, signatures, custom_signatures, custom_compliance_controls, compliance_controls See Including Objects for more information.	[optional]

Return type

Stat

Authorization

No authorization required

HTTP request headers

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