Developers
Reports12

List product performance

GET/reports/products

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.

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

limit?integer

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

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"

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/products"
{  "data": [    {      "object": "report_row",      "report": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

List lesson performance for a product GET

Returns performance metrics for each lesson of the product identified by `product_id`, which is required.

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.