GET /api/v1/courses/stats
Retrieve the statistics for all courses.
The number of results is limited to 5,000 courses and 10,000 attempts.
If the number of results exceeds the limit, use the optional parameters to filter results.
Returns:
An array of objects containing identifying info and statistics for each course:
course
: detailed information about the course, with the following fields:_id
: identifier for the coursename
: title of the course
stats
: array of course statistics, with the following objects:attempts
: detailed information about the attempt, with the following fields:_id
: identifier for the attemptprogress
: learner’s progress percentage, expressed as an integer (0-100)score
: Score obtained by the learner, expressed as an integer (0-100)completedAt
: date of completion, expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.firstActivity
: date of first activity, expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.lastActivity
: date of last activity, expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.programSession
: identifier for the corresponding programSession (if the course was played as part of a program)programTemplate
: identifier for the corresponding programTemplate (if the course was played as part of a program)path
: identifier for the corresponding path (if the course was played as part of a path)pathSession
: identifier for the corresponding path session (if the course was played as part of a path)globalTime
: total time spent (in milliseconds) by the learner, expressed as an integer
user
: detailed information about the user, with the following fields:_id
: identifier for the usermail
: email of the userexternalIDs
: array ofexternalID
for the user, with the following fields:externalPlatform
: name of the external platformexternalId
: identifier for the user on the external platform
Parameters (optional)
You can add the following optional parameters to the query:
completedAtAfter
: return only stats on attempts completed after this value. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.completedAtBefore
: return only stats on attempts completed before this value. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.firstActivityAfter
: return only stats on attempts started after this value. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.firstActivityBefore
: return only stats on attempts started before this value. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.lastActivityAfter
: return only stats on attempts for which the last activity is after this value. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.lastActivityBefore
: return only stats on attempts for which the last activity is before this value. Expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z.
Servers
- https://app.360learning.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
custom |
String | No | |
name |
String | No | |
public |
String | No | |
company |
String | No | |
apiKey |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.