Reports endpoint

Reports endpoints are used for specialized reports analytics including Large Group Report, data warehousing and statistical analysis of assessment results.

See Introduction to Datasets for more information on available datasets.

Endpoints:

• Initialize Dataset
• Get Dataset

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.

Initializes a new dataset with the specified dataset_type and configuration parameters and returns the dataset_id.

If no user input files are being uploaded (determined by the file_count parameter), a job_reference will be returned.

If user input files are being uploaded, signed URLs will be returned for each file. User data is uploaded as one or more NDJSON files by sending an HTTP PUT request to each of the signed URLs. See the implementation guide for the upload process and NDJSON format.

The signed URLs expire 60 minutes after they are issued. There is no mechanism for regenerating expired URLs; instead, disregard the old dataset_id and initialize a new dataset.

Once the user data is uploaded, use the SET /jobs/reports/datasets endpoint to commence compiling the dataset.

Request body parameters

Body content type: application/json

• dataset_type string

  Specifies the type of dataset to initialize.

  See Introduction to Datasets for information on available datasets.

  Must be one of the following.

  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 update.

  If provided, a new version of the existing dataset will be generated according to the parameters of this request, and will be made available in place of the older version when ready.

Retrieves the URL location of raw data files for a specified dataset. The endpoint returns pre-signed URLs. Send an HTTP GET request to the pre-signed URL to retrieve the file.

Request body parameters

Body content type: application/json

• dataset_type string

  The type of dataset identified by dataset_id.

  See Introduction to Datasets for information on available datasets.

  Must be one of the following.

  Possible values

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

• dataset_id string

  The identifier for the dataset to retrieve.

• group_paths array[array[string]]

  Defines how data is presented at each level of the report.

  Each element is an array of group path strings, representing a valid path through the dataset's group hierarchy.