Insights
This endpoint returns a csv file containing video views, time viewed, unique viewers and time based viewership data.
Authorizations
Path parameters
perspective_uuidstringRequired
The ID of the perspective.
Query parameters
rolestring · enumOptionalPossible values:
A role to filter the users by. If not provided all insights data is aggregated.
Responses
200
Returns overview of perspective insights in a CSV.
text/plain
401
Authorization information is missing or invalid.
403
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
404
The perspective was not found by ID.
422
Invalid parameters.
get
GET /api/public/v1/perspectives/{perspective_uuid}/insights/overview HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
No content
This endpoint returns a csv file containing user name, email, role(s), completion rate and time based completion data.
Authorizations
Path parameters
perspective_uuidstringRequired
The ID of the perspective.
Query parameters
rolestring · enumOptionalPossible values:
A role to filter the users by. If not provided all insights data is aggregated.
Responses
200
Returns perspective insights for users in a CSV.
text/plain
401
Authorization information is missing or invalid.
403
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
404
The perspective was not found by ID.
422
The provided parameters are invalid.
get
GET /api/public/v1/perspectives/{perspective_uuid}/insights/users HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?