Analytics

Workspace-wide totals for a date window, with previous-window comparison

Sums views, likes, comments, shares, posts published and average views per post across the selected platforms for posts published inside the window, plus the latest follower count and engagement rate. Every metric carries previousValue and deltaPercent against the window of the same length immediately before from. partialMetrics lists metrics some selected platform cannot report, so their totals cover only the platforms that can. A metric is null when no selected platform reports it.. Requires the analytics.read permission.

get/analytics/overview

Request

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

Query parameters

fromstring date-time required

Start of the reporting window (ISO 8601). Metrics cover posts published between from and to; comparisons use the window of the same length immediately before it

tostring date-time required

End of the reporting window (ISO 8601). Must not be earlier than from. Each post reports its numbers as of to, or its first measurement after to when it was first measured later

platformsstring[]

Restrict to these platforms. Omit for every platform with analytics. MASTODON, TELEGRAM and TUMBLR have no analytics and are ignored

connectionIdsstring[]

Restrict to these accounts, by the account id from /social-accounts. Repeat the parameter for each account. Omit for every account

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

Overview metrics

partialMetricsstring[]

Metric names that at least one selected platform cannot report; their totals cover only the platforms that can

lastSyncedAtstring date-time nullable

Most recent successful sync across the selected platforms. Null when nothing has synced yet

Changes

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