Reports Endpoints

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

Initialises 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're 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.

Endpoint v1/reports/datasets
HTTP Method POST
Action Type set
dataset_type
string

Specifies the type of dataset to initialize. Must be one of:

dataset_id
string

(optional) 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.

Follow the links above to full documentation for each dataset type.

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.

Endpoint v1/reports/datasets
HTTP Method POST
Action Type get
dataset_id
string

String identifier of the dataset to retrieve.

dataset_type
string

The type of dataset identified by dataset_id. Must be one of:

Follow the links above to full documentation for each dataset type.