External: Sync Status

List Recent Sync Events

Changed on

Return the most recent stored sync events (newest first).

Events are kept in Redis for 24 h. Use this to seed the UI before opening the SSE stream, or to inspect history without subscribing.

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

Request

  • Base URL: https://api.openwearables.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.openwearables.io/api/v1/users/{user_id}/sync/recent
  • Auth: OAuth 2 (password, token URL /api/v1/auth/login)

Path parameters

user_idstring uuid required

Query parameters

limitinteger

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

event_idstring uuid

Unique ID for this event.

run_idstring required

Identifier shared by all events of the same sync run.

user_idstring uuid required
providerstring required

Provider slug (e.g. 'garmin', 'apple', 'whoop').

source'pull' | 'webhook' | 'sdk' | 'backfill' | 'xml_import' | 'linked_account' required

How the sync was initiated / what transport delivers data.

scope'historical' | 'live'

Whether the run backfills history or delivers current data.

stage'queued' | 'started' | 'fetching' | 'processing' | 'saving' | 'completed' | 'failed' | 'cancelled' required

Coarse-grained stage label for a sync run.

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

Overall outcome state for the run.

messagestring nullable
progressnumber nullable

Optional 0..1 progress.

items_processedinteger nullable
items_totalinteger nullable
errorstring nullable
primary_user_idstring uuid nullable

For LINKED_ACCOUNT events: the OW user whose sync run produced this data.

metadataobject
window_startstring date-time nullable
window_endstring date-time nullable
started_atstring date-time nullable
ended_atstring date-time nullable
timestampstring date-time

Changes

  • 4e61b8720ebbRevision changes
    • warning

      added the new stale enum value to the / response property for the response status

    • warning

      added the new unfinished enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status