Docs

Tracking

Tracking objects store learner progress. Using the API, you can fetch tracking objects for your courses and learners.

Get trackings Build and above

Use this endpoint to get tracking objects. Each row includes progress_percent, and — when the course contains scored quizzes — the best attempt's score (0–100) and passed flag.

GET/v1/headless/trackings

Query parameters

FieldTypeRequiredDefaultDescriptionOptions
idnumberYes——
identifierstringNo——
clientIdentifierstringNo——
startstringNo——
endstringNo——
lengthnumberNo100—
pagenumberNo0—

Get collection trackings Build and above

Fetch learner progress for a collection using its required id. Add identifier to select a learner or clientIdentifier to select a client. When both filters are provided, records must match both. Empty filters are ignored. Filters apply before pagination. Collection progress counts only courses taken within that collection session.

GET/v1/headless/collection/trackings

Query parameters

FieldTypeRequiredDefaultDescriptionOptions
idnumberYes——
identifierstringNo——
clientIdentifierstringNo——
startstringNo——
endstringNo——
lengthnumberNo100—
pagenumberNo0—

Get screen trackings Build and above

Use this endpoint to get tracking objects for screen learners.

GET/v1/headless/screen/trackings

Query parameters

FieldTypeRequiredDefaultDescriptionOptions
idnumberYes——
identifierstringNo——
clientIdentifierstringNo——
startstringNo——
endstringNo——
lengthnumberNo100—
pagenumberNo0—

Get user trackings Build and above

Use this endpoint to get tracking objects grouped by user.

GET/v1/headless/user/trackings

Query parameters

FieldTypeRequiredDefaultDescriptionOptions
identifierstringYes——
clientIdentifierstringNo——
startstringNo——
endstringNo——
lengthnumberNo100—
pagenumberNo0—

Get tracking Build and above

Use this endpoint to get a specific tracking object by ID.

GET/v1/headless/tracking/{id}

Path parameters

FieldDescriptionOptions
idTracking ID—

Get collection tracking Build and above

Use this endpoint to get a specific collection tracking object by ID.

GET/v1/headless/collection/tracking/{id}

Path parameters

FieldDescriptionOptions
idCollection tracking ID—

Delete tracking Build and above

The record is marked deleted immediately and is no longer reported, launchable or resumable. Hosted SCORM resume state and CMI conversation logs are permanently removed straight away. The record and everything else under it — answers, attempts, access and the outcome — are permanently deleted after the workspace retention period, which also applies to every embed customer. A workspace keep-forever policy retains deleted records unless the workspace or customer is closed or the customer is deleted through the API. Until that deadline, staff can restore it on request.

DELETE/v1/headless/tracking

Body parameters

FieldTypeRequiredDescOptions
idnumberYesCourse ID—
identifierstringYesLearner identifier whose tracking against this course should be deleted—
clientIdentifierstringNoRestrict deletion to a tenant-scoped learner—