GET /api/v1/paths/sessions/{sessionId}/stats/{userEmailOrId}

Return the progress, time spent, score and completion date of a user on a given path session.

Error messages

Status codeError bodyReason
404{ "error": "path_session_not_found" }The path session ID is incorrect (the session doesn’t exist, or exists in another platform).
404{ "error": "user_not_found" }The user ID or email is incorrect (the user doesn’t exist, or exists in another platform).
404{ "error": "user_not_enrolled" }The user isn’t enrolled in the path session (but the user and the path session both exist in the platform).

If both the session and the user are incorrect, return path_session_not_found.

Fields

Servers

Path parameters

Name Type Required Description
userEmailOrId String Yes

ID or email of the enrolled user

sessionId String Yes

ID of the path session.

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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.