TagMango DocsCourse
List Course Reporting Students
Returns paginated per-student progress, watch time, catalog click data, and course rating (if the learner submitted a review).
Pass csv=true to download results as CSV instead of JSON.
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
courseId*string
Course object id
Query Parameters
limit?number
Number of items per page of the results
Range
1 <= valuepage?number
Page number of the results
Range
1 <= valuecsv?boolean
Boolean value to indicate if the response should be in CSV format
startDate?string
Start date for filtering data
Format
date-timeendDate?string
End date for filtering data
Format
date-timesearch?string
Search by student name or email
sortOn?string
Field to sort on
Default
"progress"Value in
"progress" | "updatedAt" | "createdAt" | "watchTimeSeconds" | "catalogClickCount" | "rating"sortOrder?string
Default
"DESC"Value in
"ASC" | "DESC"Header Parameters
x-whitelabel-host*string
Host name of the dashboard, ex: mydomain.tagmango.com
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api-prod-new.tagmango.com/api/v1/external/courses/66c4964c11e7fef26751f3a7/reporting/students" \ -H "x-whitelabel-host: string"{
"data": [
{
"userId": "64a7b8c9d1e2f3a4b5c6d7e8",
"name": "Jane Doe",
"email": "jane@example.com",
"progressPercent": 65,
"status": "in_progress",
"startedAt": "2019-08-24T14:15:22Z",
"lastVisit": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"watchTimeSeconds": 1200,
"watchTimeIsEstimated": false,
"catalogClickCount": 2,
"rating": 5
}
],
"total": 42
}{
"code": 400,
"type": "Bad Request",
"statusMessage": "BAD_REQUEST",
"success": false,
"message": "Invalid request",
"result": "Invalid request"
}{
"code": 401,
"type": "Unauthorized",
"statusMessage": "UNAUTHORIZED",
"message": "Invalid token",
"result": "Invalid token",
"success": false
}{
"code": 403,
"type": "Forbidden",
"statusMessage": "FORBIDDEN",
"errorCode": "WORKSHOP_MANGO_FORBIDDEN",
"message": "You can not access this api with a TagMango account, only available for whitelabel hosts",
"result": "You can not access this api with a TagMango account, only available for whitelabel hosts",
"success": false
}{
"code": 429,
"type": "Too Many Requests",
"statusMessage": "TOO_MANY_REQUESTS",
"message": "Request limit exceeded. try after 10 seconds",
"result": "Request limit exceeded. try after 10 seconds",
"success": false
}