Skip to main content
POST
/
v1
/
discovery
/
connections
/
{connectionId}
/
extractions
Start a connection extraction
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": {}
  }
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

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
required

The unique identifier of the connection.

Body

application/json

Extraction request payload

Request payload for starting a data extraction from a discovered connection

​
tables
object
required

Tables to extract data from, keyed by table name

​
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

Response

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

​
filters
object

Optional row-level filters for an extraction

​
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

Example:

0

​
bridgeLastError
string

Error class of the last bridge pipeline failure

Example:

""

​
bridgeLastErrorMessage
string

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

Example:

""

​
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