Analytics

Trigger an async sync

Kicks off a fresh sync from every connected platform (or one, if platform is set). Returns 202 Accepted immediately with a job_id; the actual multi-minute work runs in a background worker. Poll data.status_url until the job reports completed.

Only one queued/running sync per workspace at a time. Repeat requests while a job is in flight return 409 SYNC_IN_PROGRESS with the existing job_id in details so clients can attach to it instead of retrying.

Idempotency-safe: replay the same Idempotency-Key within the retention window and the original 202 payload is returned instead of enqueueing a duplicate.

post/analytics/sync

Request

  • Base URL: https://api.shortsync.app/v1
  • URL: https://api.shortsync.app/v1/analytics/sync
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional client-generated unique key (e.g. a UUID) to make POST operations safe to retry. Replays within 24h return the original response body and status code. Use a fresh key per logical operation.

Request body

platform'instagram' | 'tiktok' | 'youtube' | 'facebook' | 'snapchat' | 'pinterest' | 'threads' | 'twitter' | 'bluesky' | 'linkedin' | 'reddit' | 'telegram' | 'mastodon' | 'discord' | 'tumblr' | 'pixelfed' | 'google_business'

Response

Sync job enqueued.

Changes

No recorded changes to this operation across all 1 revision of this API.