Skip to main content
POST
Start a connection extraction

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

Path Parameters

connectionId
string<uuid>
required

The unique identifier of the connection. Connection ID (UUID)

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Body

application/json

Extraction request payload

tables
object
required

Per-table extraction configuration keyed by table name; at least one entry required

endDate
string

Optional inclusive end date (RFC 3339); must be on or after startDate

Example:

"2026-06-30"

filters
object

Optional extraction filters

startDate
string

Optional inclusive start date (RFC 3339)

Example:

"2026-06-01"

Response

Extraction request created

connectionId
string
required

Connection the extraction runs against

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

createdAt
string<date-time>
required

Timestamp the extraction request was created (RFC 3339)

Example:

"2026-06-17T14:32:05Z"

id
string
required

Internal extraction request identifier

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

status
string
required

Current lifecycle status of the extraction request

Example:

"pending"

tables
object
required

Per-table extraction configuration keyed by table name

updatedAt
string<date-time>
required

Timestamp the extraction request was last updated (RFC 3339)

Example:

"2026-06-17T14:32:05Z"

endDate
string

Inclusive end date of the extracted range (RFC 3339)

Example:

"2026-06-30"

errorMessage
string

Sanitized error message when the extraction failed; empty otherwise

filters
object

Extraction filters applied to the request, when set

ingestionJobId
string

Ingestion job created from the extracted data, once available

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

startDate
string

Inclusive start date of the extracted range (RFC 3339)

Example:

"2026-06-01"