Analytics

Ask for an analytics refresh now

Queues a sync for every connected account with analytics and re-reads the last 7 days. Analytics refresh on their own every few hours, so this is for "I just published, show me numbers" moments. Rate limited to one run per workspace every 4 hours: inside the cooldown the response is 200 with queued: false and cooldownSecondsRemaining, never an error. Read /analytics/sync-status to see the run finish.. Requires the analytics.sync permission.

post/analytics/sync

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/analytics/sync
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Response

Sync request result

queuedboolean

True when a sync was queued. False inside the 4 hour cooldown, or when no connected account supports analytics

messagestring
cooldownSecondsRemaininginteger nullable

Seconds until the next sync can be requested; null when queued

Changes

No recorded changes to this operation across all 2 revisions of this API.