For Developers
Extractions Overview
An Extraction is the first stage in the Edlink synchronization workflow for extract-capable providers. During an extraction, raw data is scraped from provider endpoints and stored in an isolated staging extraction database.
Team source HTTP methods for listing, fetching, creating, or canceling extractions, and for updating an extractor, are not part of this API. Edlink starts extraction runs on its own schedule.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier for the extraction run. |
status | String | Execution status: working, cancelation_pending, finalizing, canceled, error, or complete. |
start_date | Date | When the extraction started. |
end_date | Date | When the extraction ended, if it has ended. |
includes_migration | Boolean | Whether this extraction includes a migration. |
configuration | Object | Extractor configuration captured for the run. |
error | Object | Error payload when status is error. |
extractor | Object | Extractor that produced this run. |
extractor_schema | Object | Schema used for the extraction. |
JSON Example
{
"id": "4a18dc60-5ff0-482a-9e1e-28ebc9735d10",
"status": "complete",
"start_date": "2024-06-21T05:01:00.000Z",
"end_date": "2024-06-21T05:30:00.000Z",
"includes_migration": false
}
