Data8 Logo

Data8 Administration & Batch Data Cleansing API

Manage your Data8 account, submit data to batch data cleansing jobs and retrieve the results

Jobs are submitted to workflows that are built for you by the Data8 Production Team to your specifications, and the details of the data to be provided to each workflow and generated by it will be documented by them.

If you do not already have a workflow available to submit jobs to, please get in touch with your account manager to discuss your requirements.

All requests must be authenticated using an Authorization: Bearer header, with the bearer token being obtained from the Data8 OAuth token server at https://auth.data-8.co.uk/connect/token.

/Dataset/{name}/data

Downloads data from an output dataset.

HTTP Method: GET

Operation Id: Dataset_DownloadBlock

The dataset given by the name parameter must be a completed output dataset. If the dataset is an input dataset, or if it is incomplete, a 400 error is returned.

Up to 1,000 records can be downloaded at a time. Use the GET /Dataset/{name} endpoint to retrieve the total number of records, and make multiple requests to get the records in blocks of up to 1,000.

The starting point of each block of records is given by the start parameter. The first record in a dataset is number 1.

Parameters

The name of the dataset to download the records from

The number of the first record to download. The first record in a dataset is number 1

The total number of records to download

Responses

The requested dataset does not exist

Example Value Schema
{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

The request has succeeded and the requested records have been returned

A validation error has occurred

Example Value Schema
{
	"errors": {},
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string",
	"errors": {}
}
An error has occurred. This application may no longer respond until reloaded. Reload 🗙