Login

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

FieldTypeDescriptionRequiredDefaultPattern
idintegerCourse IDNo N/A N/A
identifierstringFilter to trackings associated with this identifierNo N/A N/A
clientIdentifierstringFilter to trackings associated with this clientIdentifierNo N/A N/A
startFilter to tracking created after this dateNo N/A N/A
endFilter to tracking created before this dateNo N/A N/A
completedReturn completed trackings onlyNo N/A N/A
pageintegerWhich page of items to display, starting with zeroNo N/A N/A
lengthintegerItems per page (0-100)No N/A N/A

Responses

CodeDescription
200Trackings 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

FieldDescriptionRequired
idID of the CourseYes
identifierIdentifier of the TrackingYes

Responses

CodeDescription
200Tracking record deleted