Start a connection extraction

Use this endpoint to create an extraction request for a discovered connection and submit it to Fetcher 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": {},
  "startDate": "<string>",
  "endDate": "<string>",
  "filters": {
    "equals": {}
  }
}
'

201

{
  "id": "<string>",
  "connectionId": "<string>",
  "status": "<string>",
  "ingestionJobId": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "tables": {},
  "filters": {
    "equals": {}
  },
  "errorMessage": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "bridgeAttempts": 0,
  "bridgeLastError": "",
  "bridgeLastErrorMessage": "",
  "bridgeFailedAt": "2023-11-07T05:31:56Z",
  "custodyDeletedAt": "2023-11-07T05:31:56Z"
}

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 · requerido

The unique identifier of the connection.

Cuerpo

application/json

Extraction request payload

Request payload for starting a data extraction from a discovered connection

tables · object · requerido

Tables to extract data from, keyed by table name

Show child attributes

startDate · string

Start of the date range to extract (RFC 3339)

endDate · string

End of the date range to extract (RFC 3339)

filters · object

Optional row-level filters for an extraction

Show child attributes

Respuesta

201

application/json

Extraction request created

An extraction request submitted to Fetcher

id · string

Internal identifier for the extraction request

connectionId · string

Connection this extraction was submitted to

status · string

Current lifecycle status of the extraction

ingestionJobId · string

Job identifier returned by Fetcher

startDate · string

Start of the extracted date range

endDate · string

End of the extracted date range

tables · object

Per-table extraction status

Show child attributes

filters · object

Optional row-level filters for an extraction

Show child attributes

errorMessage · string

Error details if the extraction failed

createdAt · string

Timestamp when the extraction was requested

updatedAt · string

Timestamp of the last status update

bridgeAttempts · integer

Number of times the Matcher bridge pipeline has attempted to retrieve and ingest this extraction

Ejemplo:

0

bridgeLastError · string

Error class of the last bridge pipeline failure

Ejemplo:

""

bridgeLastErrorMessage · string

Appended-history error message from the bridge pipeline; primary failure stays at the head

Ejemplo:

""

bridgeFailedAt · string<date-time> | null

Timestamp of the first terminal bridge failure; omitted when no failure has occurred

custodyDeletedAt · string<date-time> | null

Timestamp when the custody object was deleted; omitted when still held