Skip to main content
GET
/
api
/
v1
/
bulk-exports
/
{bulk_export_id}
/
runs
/
{run_id}
Error
A valid request URL is required to generate request examples
{
  "bulk_export_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {
    "prefix": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "result": {
      "rows_written": 123,
      "exported_files": [
        "<string>"
      ],
      "export_path": "<string>",
      "latest_cursor": "<string>",
      "pending_upload": {
        "target_cursor": "<string>",
        "file_path": "<string>",
        "rows_count": 123
      }
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retry_number": 0,
  "errors": {},
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
bulk_export_id
string<uuid>
required
​
run_id
string<uuid>
required

Response

Successful Response

​
bulk_export_id
string<uuid>
required
​
metadata
BulkExportRunMetadata · object
required
​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
Cancelled,
Completed,
Created,
Failed,
TimedOut,
Running
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
finished_at
string<date-time> | null
required
​
session_id
string<uuid> | null
​
retry_number
integer
default:0
​
errors
Errors · object
​
start_time
string<date-time> | null
​
end_time
string<date-time> | null