Pular para o conteúdo principal
POST
Start a connection extraction

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

Parâmetros de caminho

connectionId
string<uuid>
obrigatório

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

Exemplo:

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

Corpo

application/json

Extraction request payload

tables
object
obrigatório

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

Exemplo:

"2026-06-30"

filters
object

Optional extraction filters

startDate
string

Optional inclusive start date (RFC 3339)

Exemplo:

"2026-06-01"

Resposta

Extraction request created

connectionId
string
obrigatório

Connection the extraction runs against

Exemplo:

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

createdAt
string<date-time>
obrigatório

Timestamp the extraction request was created (RFC 3339)

Exemplo:

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

id
string
obrigatório

Internal extraction request identifier

Exemplo:

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

status
string
obrigatório

Current lifecycle status of the extraction request

Exemplo:

"pending"

tables
object
obrigatório

Per-table extraction configuration keyed by table name

updatedAt
string<date-time>
obrigatório

Timestamp the extraction request was last updated (RFC 3339)

Exemplo:

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

endDate
string

Inclusive end date of the extracted range (RFC 3339)

Exemplo:

"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

Exemplo:

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

startDate
string

Inclusive start date of the extracted range (RFC 3339)

Exemplo:

"2026-06-01"