Analytics

Best-performing posts in the window by one metric

The top limit posts published inside the window, ordered by sortBy (default VIEWS). Same rows as /analytics/posts without pagination.. Requires the analytics.read permission.

get/analytics/top-posts

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/analytics/top-posts
  • 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

sortBy'VIEWS' | 'LIKES' | 'COMMENTS' | 'SHARES' | 'SAVES' | 'CLICKS' | 'IMPRESSIONS' | 'ENGAGEMENT_RATE' | 'PUBLISHED_AT'
limitinteger

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

Top posts

Changes

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