Aggregation Events

This section provides examples for Aggregation event types.

Historical

URI Method Description
/ids-data-api/v1/aggregation-events/history?fromTime=<fromTime>&toTime=<toTime>ruleId=<ruleIds>&metric=<metric>
GET This API retrieves all the aggregated metrics. If rule and metric are specified in the query params then events will be filtered based on those params.

Method: GET

URI:

http://impactids-edge-01/ids-data-api/v1/aggregation-events/history?fromTime=1990-01-01T00:00:00&toTime=2021-12-01T00:00:00&ruleId=6fc423a0-e076-11eb-9103-93d0f1a72804

Response: 200 OK:

[
  {
    "groupName": "auto2",
    "ruleName": "MoreWriteResponsePerDayAgg",
    "details": {},
    "metric": "352253064335014",
    "value": 7.0
  }
]

Bulk

URI Method Description
/ids-data-api/v1/aggregation-events/history?fromTime=<fromTime>&toTime=<toTime>
GET This API retrieves all the aggregated metrics in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.

Method: GET

URI:

 http://impactids-edge-01/ids-data-api/v1/aggregation-events/bulk?fromTime=2015-01-01T00:00:00&toTime=2022-12-01T00:00:00

Response: 200 OK:

[{"groupName":"auto1","ruleName":"MoreRegistrationPerDayAgg","details":{},"metric":"impact30082018","value":7.0},
{"groupName":"auto1","ruleName":"MoreObservationPerDayAgg","details":{},"metric":"352253064335284","value":7.0}]