Tracking
Tracking are objects that store learner progress. Using the API, you can fetch tracking objects for your courses and learners.
Get trackings Available on request only
GET /api/v1/headless/trackings
Use this endpoint to get tracking objects.
Query parameters
Field | Type | Description | Required | Default | Pattern |
---|---|---|---|---|---|
id | integer | Course ID | No | N/A | N/A |
identifier | string | Filter to trackings associated with this identifier | No | N/A | N/A |
clientIdentifier | string | Filter to trackings associated with this clientIdentifier | No | N/A | N/A |
start |
| Filter to tracking created after this date | No | N/A | N/A |
end |
| Filter to tracking created before this date | No | N/A | N/A |
completed |
| Return completed trackings only | No | N/A | N/A |
page | integer | Which page of items to display, starting with zero | No | N/A | N/A |
length | integer | Items per page (0-100) | No | N/A | N/A |
Responses
Code | Description |
---|---|
200 | Trackings matching criteria returned. |
Delete tracking
DELETE /api/v1/headless/tracking
Use this endpoint to delete a tracking object by course ID and identifier.
FormData properties
Field | Description | Required |
---|---|---|
id | ID of the Course | Yes |
identifier | Identifier of the Tracking | Yes |
Responses
Code | Description |
---|---|
200 | Tracking record deleted |