Developers
Reports12

Retrieve the points ranking

GET/reports/rankings

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.

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

period?string

Time window of the ranking. With custom, send from and to.

Value in

  • "all"
  • "today"
  • "last_7_days"
  • "last_30_days"
  • "custom"
from?string

Required when period is custom.

Formatdate
to?string

Required when period is custom.

Formatdate
product_id[]?array<string>

Only points related to these products, by public ID. Repeat the parameter to send several products.

product_id?array<string>
Deprecated

Deprecated alias of product_id[].

limit?integer

Maximum number of items to return, from 1 to 100.

Range1 <= value <= 100

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/rankings"
{  "data": {    "cache_ttl_seconds": 0,    "entries": [      {        "points": 0,        "position": 0,        "user": {          "avatar": "string",          "name": "string"        },        "user_id": "string"      }    ],    "generated_at": "2019-08-24T14:15:22Z",    "object": "ranking",    "period": {      "from": "2019-08-24T14:15:22Z",      "kind": "all",      "to": "2019-08-24T14:15:22Z"    },    "scope": {      "product_ids": [        "string"      ]    },    "summary": {      "participants": 0,      "total_points": 0    }  }}

List product performance GET

Returns one row per product accessible with the current credentials. Products outside that scope are excluded from both the rows and any totals. This report does not include user data.

Retrieve support metrics GET

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.