GET /api/v1/courses/{courseId}/stats
Retrieve the statistics for a given course.
Returns:
An array of objects containing attempts statistics and identifying info on the user:
- attempts: Detailed information about the attempt, with the following fields:
_id: Attempt’s idprogress: 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. Format is ISO 8601.firstActivity: Date of first activity. Format is ISO 8601.lastActivity: Date of last activity. Format is ISO 8601.globalTime: Total time spent (in milliseconds) by the learner, expressed as an integerprogramSession: Identifier of the corresponding programSession (if the course was played as part of a program)programTemplate: Identifier of the corresponding programTemplate (if the course was played as part of a program)path: Identifier of the corresponding path (if the course was played as part of a path)pathSession: Identifier of the corresponding path session (if the course was played as part of a path)
user: Detailed information about the user, with the following fields:_id: Identifier of the usermail: Email of the userexternalIDs: Array ofexternalIDfor the user, with the following fields:externalPlatform: Name of the external platformexternalId: Identifier of 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
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
courseId |
String | Yes |
Identifier of the course. |
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.