Retrieve the users report

GET/reports/users

Returns summary figures and a time series of user registrations and activity.

from and to are optional and default to the last 90 days. from must not be later than to, and the range cannot exceed 90 days.

Figures are aggregated periodically rather than in real time. The consistency object indicates the data source and how fresh the figures are.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

from?string

First day of the date range (ISO 8601). Defaults to 90 days before to.

Formatdate
to?string

Last day of the date range (ISO 8601). Defaults to today.

Formatdate

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reports/users"
{  "data": {    "consistency": {},    "series": [      {}    ],    "summary": {},    "window": {}  }}