Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Event Metrics

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

get/eventMetrics

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:2021-04-22T00:00:00.000+00:00

Maximum timestamp to list auditlogs.

timestamp__gtestring date-time
Example:2021-04-22T00:00:00.000+00:00

Minimum timestamp to list auditlogs.

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
      ]
    ]
  }
]