v8

OpenAPI 3.1.02026-08-033623795.0 MB
Stats

Raw stats

Query raw data from a resource. Returns paginated rows with all columns.

Required permissions:

  • stats:read
get/stats/raw

Query parameters

resourcestring required

Resource path using : as separator (e.g., 'members', 'payments:membership').

fromstring date-time nullable

Start of time range (unix timestamp).

Example:2023-12-01T05:00:00.401Z
tostring date-time nullable

End of time range (unix timestamp).

Example:2023-12-01T05:00:00.401Z
limitinteger nullable

Number of records to return (max 10000).

Example:42
cursorstring nullable

Pagination cursor for next page.

sortstring nullable

Column to sort by.

sort_direction'asc' | 'desc'

The direction of the sort.

company_idstring nullable

Scope query to a specific company.

Example:biz_xxxxxxxxxxxxxx
user_idstring nullable

Scope query to a specific user.

Example:user_xxxxxxxxxxxxx

Response

A successful response

columnsstring[] nullable required

Column names in the order they appear in each data row.

dataobject[] nullable required

Array of data rows, where each row is an array of values matching the columns order.

nodestring nullable required

The node path that was queried.