Syncs
Get sync diagnostics
The work queued, in flight, locked and waiting for a rescrape per app and table of a sync, and how much of it is stuck.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
base_id*stringThe sync.
uuidregion*RegionsThe region of the sync
"besg""usnv"stuck_threshold_in_seconds?Stuck Threshold In SecondsWork older than this is counted as stuck, in seconds
1 <= value3600OK
application/json- response
GET /bases/<base_id>/diagnostics
base_id*Base Idstuck_threshold_in_seconds*Stuck Threshold In Secondsapps*array<>curl -X GET 'https://api.stacksync.com/v1/workspaces/0/bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/diagnostics?region=besg'{ "base_id": "<base_id>", "stuck_threshold_in_seconds": 0, "apps": [ { "app_id": "<app_id>", "tables": [ { "table_mapping_id": "<table_mapping_id>", "table_name": "<table_name>", "change_queue_count": 0, "change_queue_future_count": 0, "change_queue_stuck_count": 0, "ongoing_write_count": 0, "ongoing_write_stuck_count": 0, "record_locks_count": 0, "record_locks_stuck_count": 0, "rescrape_count": 0, "rescrape_stuck_count": 0 } ] } ]}GETGet sync metrics
The record, issue and pending change counts of a sync, per app and table: what the sync page's Statistics tab shows.
POSTCreate a sync
Create a sync between two apps from the tables and columns you pair with mapping ids. Stacksync reads both apps, checks every table and column, creates the tables marked `create_new_table` and stores the sync switched off: switch it on with the switch route. Send `validate_only: true` to run every check and get the sync as it would be stored without creating it.