v1

latestOpenAPI 3.0.22026-07-144652931.4 MB

Analytics

Get raw user analytics data

Allows users to retrieve a raw list of user analytics data within their account. This endpoint provides detailed data about user activity and account configuration.

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

Scoped OAuth requires: analytics.write

post/analytics/raw/users

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Request body

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.

Example request

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

Response

firststring

Cursor to identify the first object in the response.

laststring

Cursor to identify the last object in the response.

limitinteger

Number of results to include in the batch.

moreboolean

Indicates if there are more resources available than were returned.

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.

time_zonestring

The time zone that the results are in.