GET /api/v1/programs/sessions/{session_id}/stats
Retrieve detailed statistics for a Program session.
Returns:
_id: ID of the program session.name: Title of the program session.attendees: Number of users who started the program session.certificates: Number of users who received a certificate.completed: Number of users who completed the program session.openUsers: Number of users who registered to the program session from the Catalog of their group.registered: Total number of registered users (assigned individually, assigned through a group, or who self-registered from the Catalog).usersStats: Detailed stats for each user in the program session._id: ID of the user.deleted:trueif the user is deleted on the platform;falseotherwise.firstName: First name of the user.lastName: Last name of the user.mail: Email address of the user.customFields: Array of custom fields for the user, with the following three fields:customFieldId: ID of the custom field.value: value of the custom field.name: title of the custom field.
endTime: Date and hour when the user completed the program session.nullif the user hasn’t started it.totalTimeSpentInSeconds: Number of seconds spent by the user in the courses of the program session.progress: Percentage (in integer) of the user’s completion rate on the path session.0if the user hasn’t started it yet.scorePercentage (in integer) of the user’s score on the path session.nullif the user hasn’t completed it yet.startTime: Date when the user has started the path session.nullif the user hasn’t completed it yet. Format is ISO 8601.successfullyCompleted:trueif the user has completed the program session;falseotherwise.
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
session_id |
String | Yes |
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. |
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.