Docs

Tracking

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

Get trackings Scale 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 Scale and above

Use this endpoint to get tracking objects for collection learners.

GET/v1/headless/collection/trackings

Query parameters

FieldTypeRequiredDefaultDescriptionOptions
idnumberYes——
startstringNo——
endstringNo——
lengthnumberNo100—
pagenumberNo0—

Get screen trackings Scale 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 Scale 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 Scale 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 Scale 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 Scale and above

Soft-delete a learner's tracking against a course by course ID and identifier. The outcome record — score, pass/fail, and completion date — is kept for reporting and record-keeping. Hosted SCORM resume state and CMI conversation logs (per-question answers and runtime events) are permanently removed, and the learner can no longer launch or resume the course.

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—