EAeagleeyenetworks
Event Metrics

GET /eventMetrics

Returns metrics data indicating the number of occurrences of a given event over time.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/eventMetrics
  • Auth
    HTTP bearer

Query parameters

actorstring required
Example:camera:100d4c41

The actor for which the metrics are to be retrieved. The actor type has to be prefixed along with actor id like actorType:actorId. For example, to get the metrics for camera with id 100d4c41, the actor that has to be used is camera:100d4c41.

timestamp__ltestring date-time
Example:2023-04-04T11:48:52.000Z

Maximum timestamp to list metrics. Defaults to now.

timestamp__gtestring date-time
Example:2023-04-04T09:38:37.372Z

Minimum timestamp to list metrics. Defaults to 7 days ago.

eventTypestring required
Example:een.motionDetectionEvent.v1

The type of event that will be counted. The set of all possible types can be found using the /eventTypes API. Only a single event type can be specified.

aggregateByMinutesinteger
Example:30

The time interval, in minutes, for grouping the event metrics. It specifies the granularity of the time buckets used for aggregating event metrics. It defaults to 60 minutes (1 hour) if not specified.

Response

OK

targetstring required

Example response

[
  {
    "target": "bandwidth",
    "dataPoints": [
      [
        1557385723416,
        2.5
      ],
      [
        1557385731634,
        3.5
      ]
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.