Get bulk export runs

Get a bulk export’s runs

GET /api/v1/bulk-exports/{bulk_export_id}/runs

Error

A valid request URL is required to generate request examples

200

[
  {
    "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"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

bulk_export_id · string<uuid> · required

Query Parameters

limit · integer | null

Required range: 1 <= x <= 1000

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

Successful Response

bulk_export_id · string<uuid> · required

metadata · BulkExportRunMetadata · object · required

Show child attributes

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 | null

start_time · string<date-time> | null

end_time · string<date-time> | null