Tracking
Tracking are objects that store learner progress. Using the API, you can fetch tracking objects for your courses and learners.
Get trackings Requires Headless course creation
GET /api/v1/headless/trackings
Use this endpoint to get tracking objects.
Query parameters
| Field | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
id | integer | Course ID | Yes | 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 |
Examples
curl -X GET "https://api.coassemble.com/api/v1/headless/trackings?id=1234&identifier=user123&clientIdentifier=client456&page=0&length=50" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Get tracking Requires Headless course creation
GET /api/v1/headless/tracking/:id
Use this endpoint to get a specific tracking object by ID. This endpoint requires headless authoring access.
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 |
Examples
curl -X DELETE "https://api.coassemble.com/api/v1/headless/tracking" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d "id=1234&identifier=user123"