For Developers

Syncs Overview

A Sync represents a single scheduled or on-demand execution of Edlink's data synchronization pipeline. During a sync, data is fetched from the source provider, normalized into standard Edlink entities, validated, and loaded into the regional database.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the sync execution run.
created_dateDateWhen the sync was queued.
updated_dateDateLast time the sync record was updated.
started_dateDateTimestamp when sync processing actually began.
completed_dateDateTimestamp when sync completed (successfully or failed).
stateStringCurrent execution status: queued, running, completed, failed, or cancelled.
typeStringType of sync run (e.g. scheduled, manual, backfill).
source_idUUIDIdentifier of the data source being synchronized.
parent_idUUIDParent sync ID if this is a sub-sync run.

JSON Example

{
    "id": "673cf97a-9a91-4560-8f96-3a72df54db12",
    "created_date": "2024-06-21T06:00:00.000Z",
    "updated_date": "2024-06-21T06:45:00.000Z",
    "started_date": "2024-06-21T06:01:00.000Z",
    "completed_date": "2024-06-21T06:45:00.000Z",
    "state": "completed",
    "type": "scheduled",
    "source_id": "7b5a19cb-9ea8-4b71-9b16-564ec5ea0b12"
}