External: Sync Status

List Stored Sync Runs

Stored sync runs for a user, newest first.

Unlike /sync/runs this reads from the database rather than the Redis event buffer, so it is not limited to the last 24 hours. Only historical runs are stored by default. Use /sync/history/{run_key} for the per-data-type breakdown.

since filters on when a run executed. covered_from / covered_to filter on the span of data it was meant to cover, which is what answers "what ran that was supposed to cover March" — a backfill started yesterday covering March matches. A run matches when its own window overlaps the range or when any of its data types covered a span that does; runs with no recorded window on either level are excluded, since overlap is undecidable.

get/api/v1/users/{user_id}/sync/history

Path parameters

user_idstring uuid required

Query parameters

limitinteger
scope'historical' | 'live'

Whether the run backfills history or delivers current data.

Filter by historical or live.

sincestring date-time nullable

Only runs started at or after this time.

Only runs started at or after this time.

providerstring nullable

Filter by provider name.

Filter by provider name.

covered_fromstring date-time nullable

Only runs whose covered data window ends after this time.

Only runs whose covered data window ends after this time.

covered_tostring date-time nullable

Only runs whose covered data window starts before this time.

Only runs whose covered data window starts before this time.

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