Developers
Users

List progress adjustments

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

Returns the progress adjustments recorded for the user in a product, using cursor-based pagination.

Each adjustment identifies its author as either an administrator (admin) or an API credential (credential).

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
product_id*string

Query Parameters

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users/string/products/string/progress/adjustments"
{  "data": [    {      "author": {        "id": "string",        "kind": "admin"      },      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "object": "progress_adjustment",      "product_id": "string",      "reason": "string",      "result": {        "history_removed": 0,        "lessons_cleared": 0      },      "type": "reset",      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Retrieve product progress GET

Retrieves the user's progress in a single product, in the same format used when listing the user's progress across products.

Create a progress adjustment POST

Creates a progress adjustment for the user in a product. A `reset` adjustment clears the user's progress in the product. The `reason` is stored with the adjustment. Points and certificates already earned are not reverted by a reset.