Trigger Asynchronous Data Extraction via API

You can trigger data extraction asynchronously and gather metadata for executed extractions using REST API endpoints.

Process Diagram 

Asynchronous extraction allows you to trigger an execution of an extraction using the Trigger an Extraction (1) endpoint. Such extraction is triggered based of the extractionConfigId parameter. Only submitted extracts, i.e. extracts which don’t have a DRAFT status and have not yet reached their end date can be triggered using this endpoint.

If an extract has the Split by option configured, the output will be divided based on the attribute selected to split the data. You can retrieve  the status for one of the split extracts by using the Get the status of one sub-extract of an execution endpoint. For non-split extracts this endpoint will return the status of the entire extract.

Additionally, you can:

List executions for a given extract configuration using the List executions for an Extract Configuration endpoint (10), this list will include re-runs of the execution:

1
{
2
  "data": [
3
    {
4
      "id": "string",
5
      "extractConfigurationId": "string",
6
      "latestStatus": "PENDING",
7
      "latestStartedAt": "2026-05-28T14:00:00Z",
8
      "latestCompletedAt": "2026-05-28T14:05:00Z",
9
      "latestRunRecordCount": 0,
10
      "totalRuns": 0
11
    }
12
  ],
13
  "page": 0,
14
  "limit": 0,
15
  "totalSize": 0,
16
  "totalPages": 0
17
}

Query execution metadata for a given extraction, including execution history with re-runs and latest status, by using the Get execution details of a triggered extraction endpoint (7):

1
{
2
  "extractConfigurationName": "string",
3
  "extractConfigurationId": "string",
4
  "id": "string",
5
  "latestStatus": "PENDING",
6
  "latestProcessId": "string",
7
  "latestRecordCount": 0,
8
  "runs": [
9
    {
10
      "run": 0,
11
      "status": "PENDING",
12
      "processId": "string",
13
      "startedAt": "2026-05-28T14:00:00Z",
14
      "completedAt": "2026-05-28T14:05:00Z",
15
      "recordCount": 0,
16
      "errorMessage": "string",
17
      "file": {
18
        "fileName": "/namespace/Journal/financial_summary_April_v1.csv",
19
        "downloadUrl": "/api/v1/extraction-configurations/config1id/executions/exec1id/download?run=1"
20
      }
21
    }
22
  ]
23
}

Trigger a re-run of the latest execution of an extraction by using the Trigger a rerun of an execution endpoint (9). The execution must be in a re-runnable state, i.e. Completed or Failed status, and not e.g. Completed (no data), On hold, etc.

Download the file with the result of an extraction by using the Download the output file of an extraction run endpoint (12). Only results from extracts which send their output to Cloud Storage can be downloaded. For extracts with Split by option configured you can download only one of the split extracts using the Download the output file of one run of a sub-extract endpoint.