Sign in
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

Start of time range (unix timestamp).

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

End of time range (unix timestamp).

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

Number of records to return (max 10000).

Example:42
cursorstring

Pagination cursor for next page.

sortstring

Column to sort by.

sort_direction'asc' | 'desc'

The direction of the sort.

company_idstring

Scope query to a specific company.

Example:biz_xxxxxxxxxxxxxx
user_idstring

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.

Changes

Changed in 1 of the 41 revisions of this API.13

  • f67a043e319013See the full diff
    • ▲

      the query request parameter sort_direction was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value asc to the query request parameter sort_direction

      request-parameter-enum-value-added

    • ○

      added the new enum value desc to the query request parameter sort_direction

      request-parameter-enum-value-added

    • ○

      for the query request parameter sort_direction, the type/format was generalized from / to string/

      request-parameter-type-generalized