Session statuses endpoint

Manage the status for sessions which may trigger further processing tasks.

Endpoints:

• Change sessions statuses and trigger followup processing

Usage

The format of requests to the Data API use the following syntax:

https://data.learnosity.com/{LTS_VERSION}/{endpoint}

For example, to use the v2025.1.LTS version and the itembank/items endpoint, you would create a request like so:

https://data.learnosity.com/v2025.1.LTS/itembank/items

Important Data API is not a REST API. All requests must use the POST method with the action request body parameter specifying the operation to use. The Learnosity SDK must be used to make requests to Data API.

Note Data API usage is subject to rate limits.

Related articles:

• Getting Started with the Data API
• See Release Cadence and Version Lifecycle for more information on available LTS versions.

Update the status of the given sessions.

If the requested status is "Completed", followup processing tasks will also be scheduled, such as:

• rescoring - based on historical data of the Questions/Items when sessions were initially taken by learners,
• subscore calculations,
• Data API push events for the firehose service, and/or
• reports generation for Data API's sessions, reports, and adaptive.

Request body parameters

Body content type: application/json

• statuses array[object]

  An array of session status objects representing the sessions to update.

  Maximum entries: 100

  • session_id string

    The session ID to update.

  • status string

    The status to apply to the session.

    Possible values

    • Completed
    • Incomplete
    • Discarded

  • user_id string

    The user ID recorded against the session.

    Must match the user_id provided when the session was initialized.

Request body example

{
    "statuses": [
        {
          "user_id": "ANONYMIZED_USER_01",
          "session_id": "7939ead7-3242-4907-850d-3e5e48130277",
          "status": "Completed"
        },
        {
          "user_id": "ANONYMIZED_USER_02",
          "session_id": "5a74a4e9-6b6b-42a2-885e-127b795ba70c",
          "status": "Incomplete"
        }
    ]
}

Responses

Response example

{
    "meta": {
        "status": true,
        "timestamp": 1487049275
    },
    "data": {
        "job_reference": "8a3d0ca2-eaa4-4c18-b9b9-1b12164e8b4e"
    }
}