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

PropertyTypeDescription
idUUIDUnique identifier for the extraction run.
statusStringExecution status: working, cancelation_pending, finalizing, canceled, error, or complete.
start_dateDateWhen the extraction started.
end_dateDateWhen the extraction ended, if it has ended.
includes_migrationBooleanWhether this extraction includes a migration.
configurationObjectExtractor configuration captured for the run.
errorObjectError payload when status is error.
extractorObjectExtractor that produced this run.
extractor_schemaObjectSchema 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
}