Developers
Users

List user progress

GET/users/{user_id}/progress

Returns the user's progress in each product, using cursor-based pagination.

If the current credentials are restricted to specific products, only those products are included.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

user_id*string

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string

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/users/string/progress"
{  "data": [    {      "completed_at": "2019-08-24T14:15:22Z",      "completed_lessons": 0,      "last_activity_at": "2019-08-24T14:15:22Z",      "object": "product_progress",      "percent": 0,      "product_id": "string",      "started_at": "2019-08-24T14:15:22Z",      "total_lessons": 0,      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

List lesson progress GET

Returns the user's progress in each lesson of a product, using cursor-based pagination. Each entry identifies the lesson and its module by public ID.

Create a points adjustment POST

Creates a manual adjustment to the user's points. The adjustment is recorded as a point entry in the points ledger together with its author and `reason`, and the user's balance changes by the adjusted amount. `points` must be a non-zero integer; negative values deduct points. Use `product_id` to associate the adjustment with a product.