Login

Trackable links

Endpoints related to trackable links.

Endpoints

GET /api/v1/trackables/{course}

Returns a trackable link for a given course.

Path variables

FieldDescription
courseID of course

Responses

CodeDescription
200Returned when successful
400Returned when you don't have access to trackable links
403Returned when you don't have permission for the course

POST /api/v1/trackables/{course}

Creates a trackable link for a given course.

Path variables

FieldDescription
courseID of course

Body properties

FieldTypeDescriptionRequired
securedbooleanWhether this link is secured with a shared secretNo

Responses

CodeDescription
200Returned when successful
400Returned when you don't have access to trackable links
403Returned when you don't have permission for the course

Get results

GET /api/v1/trackable/report

Returns a list of results for trackable link sessions.

Query parameters

FieldTypeDescriptionRequiredDefaultPattern
coursestringCourse IDNonull\d+
identifierstringThe identifier used when directing a user to the trackable linkNonull N/A
dateFilterstringDate filterNo"completed"(completed|commenced|updated)
startstringFrom dateNonull N/A
endstringuntil dateNonull N/A
commencedstringCommenced onlyNonull N/A
completedstringCompleted onlyNonull N/A
passedstringPasseFail onlyNonull N/A
searchstringSearch by identifierNo""[\w\-\s]+
sortstringSort byNo"updated"(course.code|course.title|updated|commenced|completed)
reversestringShould sort order be reversedNo"false" N/A
pagestringWhich page of items to display, starting with zeroNo"0"\d+
lengthstringItems per page (0-100)No"10"\d+

Responses

CodeDescription
200Returned when successful
400Returned when you don't have access to trackable links