List progress adjustments
/users/{user_id}/products/{product_id}/progress/adjustmentsReturns 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).
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the user, prefixed with usr_.
Public ID of the product, prefixed with prd_.
Query Parameters
Maximum number of items to return, from 1 to 200.
1 <= value <= 200Cursor for the next page, taken from page.next_cursor of the previous response.
Header Parameters
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.
length <= 64Response 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/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. A reset requires the user to have started the product. When the user has never opened it, there is no progress to reset and the request fails with `409 progress_not_started` (`details[].reason` is `not_started`).