Start a connection extraction

Use this endpoint to create an extraction request for a discovered connection and submit it to the extraction engine for the authenticated tenant.

POST /v1/discovery/connections/{connectionId}/extractions

Start a connection extraction

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/discovery/connections/{connectionId}/extractions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tables": {},
  "endDate": "2026-06-30",
  "filters": {
    "equals": {}
  },
  "startDate": "2026-06-01"
}
'

201

Example

{
  "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-06-17T14:32:05Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "pending",
  "tables": {},
  "updatedAt": "2026-06-17T14:32:05Z",
  "endDate": "2026-06-30",
  "errorMessage": "<string>",
  "filters": {
    "equals": {}
  },
  "ingestionJobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "startDate": "2026-06-01"
}

Autorizaciones

Authorization · string · header · requerido

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

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

connectionId · string<uuid> · requerido

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

Ejemplo:

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

Cuerpo

application/json

Extraction request payload

tables · object · requerido

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

Show child attributes

endDate · string

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

Ejemplo:

"2026-06-30"

filters · object

Optional extraction filters

Show child attributes

startDate · string

Optional inclusive start date (RFC 3339)

Ejemplo:

"2026-06-01"

Respuesta

201

application/json

Extraction request created

connectionId · string · requerido

Connection the extraction runs against

Ejemplo:

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

createdAt · string<date-time> · requerido

Timestamp the extraction request was created (RFC 3339)

Ejemplo:

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

id · string · requerido

Internal extraction request identifier

Ejemplo:

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

status · string · requerido

Current lifecycle status of the extraction request

Ejemplo:

"pending"

tables · object · requerido

Per-table extraction configuration keyed by table name

Show child attributes

updatedAt · string<date-time> · requerido

Timestamp the extraction request was last updated (RFC 3339)

Ejemplo:

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

endDate · string

Inclusive end date of the extracted range (RFC 3339)

Ejemplo:

"2026-06-30"

errorMessage · string

Sanitized error message when the extraction failed; empty otherwise

filters · object

Extraction filters applied to the request, when set

Show child attributes

ingestionJobId · string

Ingestion job created from the extracted data, once available

Ejemplo:

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

startDate · string

Inclusive start date of the extracted range (RFC 3339)

Ejemplo:

"2026-06-01"