Reports Endpoints

Data API's reports endpoints are used for specialized reports analytics including Large Group Report, data warehousing and statistical analysis of assessment results. For more information on available datasets see the Datasets section.

Usage

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

https://data.learnosity.com/[LTS_VERSION]/reports/datasets

For example, to use the 2023.3.LTS version and the 'Reports Datasets' endpoint, you would create a request like so:

https://data.learnosity.com/v2023.3.LTS/reports/datasets

Initialize Dataset

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.

Get Dataset

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.