Developers
Users38

List lesson progress

GET/users/{user_id}/products/{product_id}/progress/lessons

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.

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

Public ID of the user, prefixed with usr_.

product_id*string

Public ID of the product, prefixed with prd_.

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.

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

application/json

curl -X GET "https://example.com/users/string/products/string/progress/lessons"
{  "data": [    {      "completed": true,      "completed_at": "2019-08-24T14:15:22Z",      "lesson_id": "string",      "module_id": "string",      "object": "lesson_progress"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Retrieve a progress adjustment GET

Retrieves a progress adjustment recorded for the user in a product.

List user progress GET

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.