Incident Analytics

The Incident Analytics endpoint provides analytical data on reported incidents within the platform. Each incident represents an issue logged, tracked, and resolved by staff. The endpoint returns statistics such as incident volume, resolution times, and status distributions. It is useful for monitoring operational issues and identifying recurring problem areas.

The Incident Analytics Object

Schema IncidentAnalytics not found in OpenAPI spec.

Retrieve Incident Analytics

Retrieve incidents analytics for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the analytics for.

periodStartintegerQuery RequiredField must be in query parameters.

The start of the period to query, in milliseconds since epoch.

periodEndintegerQuery RequiredField must be in query parameters.

The end of the period to query, in milliseconds since epoch.

interval

The interval for the analytics data. Can be 'day', 'week', or 'month'.

locationstring

The location for which to return analytics specific data for.

locationLabelsarray

Labels for the locations to be used in the analytics.

Returns200

The incidents analytics.

The Incident Analytics object

Endpoint

GET /v2/businesses/{business}/analytics/incidents