Trackable links

Endpoints related to trackable links.

Endpoints

GET /api/v1/trackables/{course}

Returns a trackable link for a given course.

Field	Description
`course`	ID of course

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

POST /api/v1/trackables/{course}

Creates a trackable link for a given course.

Field	Description
`course`	ID of course

Field	Type	Description	Required
`secured`	`boolean`	Whether this link is secured with a shared secret	No

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

GET /api/v1/trackable/report

Returns a list of results for trackable link sessions.

Field	Type	Description	Required	Default	Pattern
`course`	`string`	Course ID	No	`null`	`\d+`
`identifier`	`string`	The identifier used when directing a user to the trackable link	No	`null`	N/A
`dateFilter`	`string`	Date filter	No	`"completed"`	`(completed\|commenced\|updated)`
`start`	`string`	From date	No	`null`	N/A
`end`	`string`	until date	No	`null`	N/A
`commenced`	`string`	Commenced only	No	`null`	N/A
`completed`	`string`	Completed only	No	`null`	N/A
`passed`	`string`	PasseFail only	No	`null`	N/A
`search`	`string`	Search by identifier	No	`""`	`[\w\-\s]+`
`sort`	`string`	Sort by	No	`"updated"`	`(course.code\|course.title\|updated\|commenced\|completed)`
`reverse`	`string`	Should sort order be reversed	No	`"false"`	N/A
`page`	`string`	Which page of items to display, starting with zero	No	`"0"`	`\d+`
`length`	`string`	Items per page (0-100)	No	`"10"`	`\d+`

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