Developers
Gamification2

List point entries

GET/gamification/scores

Returns point entries from the points ledger, using cursor-based pagination. Points awarded automatically (lessons, comments, questions, exams, course milestones, and certificates) and manual adjustments are returned in the same collection and can be distinguished with the origin filter.

Resetting a user's progress or revoking a certificate does not remove previously awarded points. Reopening or deleting an exam attempt removes the points awarded for passing it, and the corresponding entries no longer appear in the collection.

Results are limited to the users and products accessible with the current credentials.

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

  • "created_at"
  • "-created_at"
user_id?string

Only entries of the user with this public ID.

product_id?string

Only entries related to the product with this public ID.

origin?string

Only entries with this origin, such as a lesson, a comment, or a manual adjustment.

created_after?string

Only items created after this date and time (ISO 8601).

Formatdate-time
created_before?string

Only items created before this date and time (ISO 8601).

Formatdate-time

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/gamification/scores"
{  "data": [    {      "cause": {        "adjustment_id": "string",        "exam_id": "string",        "kind": "lesson",        "lesson_id": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "links": {        "self": "string"      },      "object": "score",      "origin": "lesson_completed",      "points": 0,      "product_id": "string",      "reason": "string",      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Retrieve the points ranking GET

Returns the users ranked by points earned in the selected period. When `period` is omitted, all-time points are used; when `limit` is omitted, up to 100 positions are returned. Results are limited to the products and users accessible with the current credentials. Filtering by `product_id[]` narrows that scope and never widens it: requesting products outside the scope returns an empty ranking. Each entry includes the user's name and avatar only when the credentials also have the `users.read` permission; otherwise the `user` object is `null`. Rankings are eventually consistent. Manual point adjustments are reflected on the next request, while automatically awarded points may take up to `cache_ttl_seconds` to appear.

Products19

Next Page