OpenMax
Free Trial

Apps API · Analytics

Analytics: 1 endpoints

← All groups

GET /api/v1/analytics/overview

Admin analytics overview

Scope: org:analytics:read · Called with: appToken · operationId: get-analytics-overview

Required app scope: org:analytics:read.

Returns the four overview metrics (humans, agents, issues, projects), each with a current total, a 7-day cumulative trend, and a week-over-week percentage. The percentage compares the current end-of-day cumulative total against the one exactly 7 days earlier (UTC day boundaries — the same samples the trend is drawn from); it is null when that earlier total was 0, since percent change from zero is undefined. Restricted to org-owner / org-admin. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
org_id query string Organization UUID; must match the caller's active org. Defaults to it when omitted.

Responses