Alerts flex report

Triggered-alerts report (count metric).

Runs a dashboard-style aggregation and returns the same visualization payload the web dashboard
uses for a widget preview. Provide one dimension, one or more same-family metrics, a
timeRange ({ startTime, endTime } in milliseconds since epoch) and optional locations/cameras
scope. metrics[].targetIds come from the dictionary endpoints (/v1/dictionary/objects,
/v1/dictionary/alerts, /v1/dictionary/eventTags). The response visualizationData.data is an
array of { xLabel, xGrid, yGrid }
grouped by the dimension.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The single dimension the report is grouped by.

Allowed:
metrics
array of objects
required

One or more metrics of the same aggregation family.

metrics*
locations
array of strings

Location GUIDs to filter by. Optional.

locations
cameras
array of strings

Camera GUIDs to filter by. Optional.

cameras
timeRange
object
required

The time window, milliseconds since epoch.

string

IANA timezone. Defaults to UTC.

Responses
200

The alerts visualization payload.

400

Unsupported dimension or missing metrics.

401

Missing or invalid API key.

403

Organization not allowed by this token.

500

Internal server error.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!