Actions

Call the getTopPosts MCP tool

Return the visitor's top-performing published posts in a recent window. Default rank is total engagement (reactions + comments + reposts); pass rank_by to switch to impressions / reactions / comments / reposts. lead_magnet_only=true limits to lead-magnet posts. Use for "what's my best post this week", "what got the most impressions". Do NOT use for campaign performance (that's getCampaignStats) or upcoming/draft posts (this only covers PUBLISHED content).

Called through the Actions bridge: the response is that tool's own result, wrapped as { data: <tool result> } under HTTP 200. Billing, daily-cap, and confirm-step outcomes are embedded INSIDE data, never remapped to an HTTP status (see the templated /api/v1/actions/{toolName} operation above for the full protocol, and x-mcp-actions for this tool's machine-readable scope/cap/confirm_behavior fields). Authentication, request-shape, and optional idempotency-protocol failures still use their documented non-200 statuses.

post/api/v1/actions/getTopPosts

Request

  • Base URL: https://app.reachium.io
  • URL: https://app.reachium.io/api/v1/actions/getTopPosts
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional caller-generated key (8-200 characters: letters, digits, dot, underscore, colon, or hyphen). A final tool result is replayed for the same key and body. An ambiguous result remains 409 under that key; reconcile external state before using a new key. Reuse with a different body returns 422.

Request body

daysinteger

Look-back window in days (1-90). Default 7.

limitinteger

How many top posts to return (1-10). Default 5.

rank_by'engagement' | 'impressions' | 'reactions' | 'comments' | 'reposts'

Ranking metric. Default "engagement".

lead_magnet_onlyboolean

If true, only count posts where is_lead_magnet is set.

Response

The result of calling this tool.

dataunknown required
errorunknown required

Changes

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