Subscores endpoint

Generates subscore information on sessions. Subscores are a breakdown of a total score achieved for an Activity.

See Using Subscores With Your Activities for more information.

Endpoints:

• Calculate Subscores Job

Usage

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

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

For example, to use the v2025.2.LTS version and the /jobs/sessions/scores/subscores endpoint, you would create a request like so:

https://data.learnosity.com/v2025.2.LTS/jobs/sessions/scores/subscores

Important The 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 The 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.

Creates a job to calculate subscore information for sessions.

You would want to use this to extract groups of Items, and focus on scoring them separately.

Note Only returns data if the subscore information was available at the time the learner attempted the session.

Request body parameters

Body content type: application/json

• session_id array[string]

  A list of session IDs for subscores to be recalculated.

  Maximum entries: 100

Request body example

{
    "session_id": [
        "8fac2b77-ebcb-42f6-a9cf-796467e8369a",
        "ea534769-d42f-404b-84eb-819023dabd05",
        "a9d6e989-c2cf-47c5-803a-c47fe49529e4",
        "f0a8b3aa-7c18-4f66-b6f6-66d99ef440d4"
    ]
}

Responses

Response example

{
    "meta": {
        "status": true,
        "timestamp": 1437958049,
        "records": 2
    },
    "data": {
        "job_reference": "6b201463-5a2b-4d75-b689-12a1bb42ac50",
        "ignored_sessions": [
            "8fac2b77-ebcb-42f6-a9cf-796467e8369a"
        ]
    }
}