v1

latestOpenAPI 3.0.22026-07-144652931.4 MB

Analytics

Get aggregated metrics for all users

Provides aggregated metrics across all users within their account. This endpoint provides summary statistics about user activity and performance.

Note: Data availability reflects pipeline processing cycles and is generally within 24 hours under normal conditions.

Scoped OAuth requires: analytics.write

post/analytics/metrics/users/all

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

time_zonestring

The time zone to use for the results and grouping. Must be in tzdata format. See list of accepted values here.

order'asc' | 'desc'

The order in which the results were sorted; asc for ascending, desc for descending.

order_bystring

The column that was used for ordering the results.

aggregate_unit'day' | 'week' | 'month' nullable

The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period.

limitinteger

The maximum number of results to return per page. The default (and maximum allowed value) is 1000.

starting_afterstring nullable

A cursor used for pagination. Starting after cursor provides the next set of results in forward pagination order.

ending_beforestring nullable

A cursor used for pagination. Ending before cursor provides the previous set of results in reverse pagination order.

{
  "time_zone": "Etc/UTC",
  "order_by": "user_id",
  "aggregate_unit": "day"
}

Returns user metrics aggregated across the account

time_zonestring

The time zone used for the results