/sync-status

GET

/sync-status

GET

/api/chat/v1/sync-status

curl https://api.merge.dev/api/chat/v1/sync-status \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "model_name": "Channel",
      "model_id": "chat.ChatChannel",
      "status": "SYNCING",
      "sync_status_reason": "WAITING_ON_OTHER_MODELS",
      "is_initial_sync": true,
      "last_sync_start": "2021-03-30T19:44:18.695973Z",
      "next_sync_start": "2021-03-30T20:44:18.662942Z",
      "last_sync_result": "DONE",
      "last_sync_finished": "2021-03-30T19:55:18.695973Z",
      "data_fresh_as_of": "2021-03-30T19:44:18.695973Z",
      "historical_data_since": "1900-01-01T00:00:00Z",
      "selective_sync_configurations_usage": "IN_NEXT_SYNC"
    }
  ]
}

Get sync status for the current sync and the most recently finished sync. last_sync_start represents the most recent time any sync began. last_sync_finished represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the last_sync_finished timestamp where last_sync_result is DONE. Possible values for status and last_sync_result are DISABLED, DONE, FAILED, PARTIALLY_SYNCED, PAUSED, SYNCING. Learn more about sync status in our Help Center.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

cursorstringOptional

The pagination cursor value.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

Response

nextstring or nullOptional

previousstring or nullOptional

resultslist of objectsOptional

Authentication

Headers

Query parameters

Response