API for CSV Export from Dataset

This page contains description how to manage CSV exports via API.

CSV file with raw statistics contains metrics and submetrics as well as other subject and image related data exported as CSV file.

Check CSV export for more details.

What can you do?

Schedule CSV export

Create csv export task for dataset

post

Create a new csv export task for a dataset

Authorizations
AuthorizationstringRequired

Authenticate using SaaS Private token

Path parameters
company_idstring · uuidRequired
dataset_idstring · uuidRequired
Body

Serializer to get dataset id from urls.

task_typestring · enumOptional
  • full_metrics - Full Metrics
  • main_metrics - Main Metrics
Possible values:
sincestring | nullOptional
untilstring | nullOptional
Responses
post
/api/v1/companies/{company_id}/datasets/{dataset_id}/csv_exports/

This method will start the export process. You can check the status of the export with list method.

CSV Export example (for the Recommendation System 1.0)
CSV Export example (for the Recommendation System 2.0)

List your CSV exports

List csv export tasks for dataset

get

List all csv export tasks for a dataset. Latest tasks are shown first by default.

Authorizations
AuthorizationstringRequired

Authenticate using SaaS Private token

Path parameters
company_idstring · uuidRequired
dataset_idstring · uuidRequired
Query parameters
orderingstringOptional

Which field to use when ordering the results.

qstringOptional

A search term.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses
200Success
application/json
get
/api/v1/companies/{company_id}/datasets/{dataset_id}/csv_exports/
200Success

When the export is ready (has status done), you can download it using the csv_link field to download the file.

PreviousAPI for DatasetsNextAPI for Algorithm Applications

Last updated

Was this helpful?