Sign in
External: Sync Status

Get Stored Sync Run

One stored sync run with its per-data-type breakdown.

get/api/v1/sync/history/{run_key}

Path parameters

run_keystring required

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

run_keystring required
user_idstring uuid required
providerstring required
source'pull' | 'webhook' | 'sdk' | 'backfill' | 'xml_import' | 'linked_account' required

How the sync was initiated / what transport delivers data.

scope'historical' | 'live' required

Whether the run backfills history or delivers current data.

status'in_progress' | 'success' | 'partial' | 'failed' | 'cancelled' | 'skipped' | 'unfinished' | 'stale' required

Overall outcome state for the run.

trace_idstring nullable
window_startstring date-time nullable
window_endstring date-time nullable
started_atstring date-time required
ended_atstring date-time nullable
items_insertedinteger
items_updatedinteger
errorstring nullable

Changes

Changed in 1 of the 17 revisions of this API.1