Datasets endpoint

Data API's datasets are used for specialized analytics including large group reports, and statistical analysis of assessment results.

See Implementing and Creating Datasets for Download or Reporting for more information.

Endpoints:

• Commence dataset job

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.

Queues a job to compile the dataset specified in the request.

Before queueing the job, the provided dataset parameters are validated to ensure the dataset is ready to be processed. When the validation is successful, the endpoint returns a job_reference. Use the GET /jobs endpoint to poll the progress of the job.

Request body parameters

Body content type: application/json

• dataset_type string

  The type of dataset to begin generating.

  Possible values

  • activity-summary-by-group
  • sessions-summary-by-group
  • ibk-analysis-by-question
  • activity-analysis-by-question

• dataset_id string

  Identifier of the dataset to begin generating. This is provided when calling the reports/datasets endpoint.

  See the datasets listed on Working With Datasets for more information.

Request body example

{
    "dataset_type": "activity-summary-by-group",
    "dataset_id": "e63de7cf-8a11-4b87-9a98-aba1af4e5340"
}

Responses

Response example

{
    "meta": {
        "status": true,
        "timestamp": 1474336936
    },
    "data": {
        "job_reference": "402ead85-5a27-4d40-b68b-7b1e77924ed4",
        "dataset_type": "activity-summary-by-group",
        "dataset_id": "e63de7cf-8a11-4b87-9a98-aba1af4e5340"
    }
}