Developers
Reports

Retrieve support metrics

GET/reports/support

Returns message volume and response metrics for each support channel within the requested date range.

from and to are required, from must not be later than to, and the range cannot exceed 90 days. Figures are computed from live data.

Authorization

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
Formatdate
to*string
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

curl -X GET "https://example.com/reports/support?from=2019-08-24&to=2019-08-24"
{  "data": {    "channels": {},    "consistency": {},    "window": {}  }}

Retrieve the points ranking GET

Returns the same points ranking as the gamification ranking endpoint. Either the `reports.read` or the `rankings.read` permission grants access. Results are limited to the products and users accessible with the current credentials. Each entry includes the user's name and avatar only when the credentials also have the `users.read` permission.

Retrieve the users report GET

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.