This collection of endpoints allow you to export raw data reports for analysis or external processing. The exported data is in a structured format (e.g., CSV, Excel, SPSS) that can be downloaded and used for further reporting or processing.

📭1. Initiate a data exportCopied!

The first step to create an export is to define what data you want to retrieve and how it should be generated. For example, suppose you were interested in exporting data from the first quarter of 2025 and would like it to be in CSV format. Send all this information in the body of an HTTP POST request to the create export endpoint and you will get the ExportId in return.

Request:

POST /v1/quests/01952000-222c-761a-8f5b-87a44ca2d73f/exports
plaintext Copy Copied!

{
  "settings": {
    "exportType": "CSV",
    "valueType": "ORDER_NUMBER",
    "expandMultipleChoiceToColumns": true,
    "includeRespondentInformation": false,
    "fieldSeparator": "PIPE",
    "showOtherAsText": false
  },
  "filter": {
    "since": "2025-01-01T00:00:00.000Z",
    "until": "2025-03-31T23:59:59.999Z"
}
json Copy Copied!

Response:

{
    "exportId": "0196aea1-1fe3-7658-adeb-3184a0a20619",
    "message": "Export job has been successfully scheduled and will begin processing shortly"
}
json Copy Copied!

Depending on the amount of data, it may take some time to generate the export file.

📫 2. Check the status of an exportCopied!

Once you get the ExportId from the previous step, you can send it to the export status endpoint to get information about the export generation process.

Request:

GET /v1/quests/01952000-222c-761a-8f5b-87a44ca2d73f/exports/0196aea1-1fe3-7658-adeb-3184a0a20619/status
plaintext Copy Copied!

Response:

{
  "exportId": "0196aea1-1fe3-7658-adeb-3184a0a20619",
  "questId": "01952000-222c-761a-8f5b-87a44ca2d73f",
  "status": "INPROGRESS",
  "lastChangedAt": "2025-05-07T19:18:07.483Z"
}
json Copy Copied!

The process starts with the PENDING status when it is added, then goes to INPROGRESS while data is being collected, and if everything is OK it ends up in the COMPLETED status, in which case your request will be automatically redirected to the export download endpoint.

Response:

StatusCode: 302 Found
Location (Header): /v1/quests/01952000-222c-761a-8f5b-87a44ca2d73f/exports/0196aea1-1fe3-7658-adeb-3184a0a20619/download
plaintext Copy Copied!

If something goes wrong, you might get the ERROR status or something similar, indicating that the export generation failed.

📬 3. Download exported dataCopied!

You may use the export download endpoint to directly stream an export file. Once an export is sucessfully created, it will be available for download for 30 days.

Request:

GET /v1/quests/01952000-222c-761a-8f5b-87a44ca2d73f/exports/0196aea1-1fe3-7658-adeb-3184a0a20619/download
plaintext Copy Copied!

Response: Export file content