Actions

Call the getCampaignStats MCP tool

Find campaigns by name substring (case-insensitive) and return their stats. Returns UP TO 3 best matches: match_count counts THIS search's matches (max 3), NOT the workspace total. Stats default to ALL-TIME totals since launch; pass days_back (1-365) to window them instead. Shape depends on campaign type/sequence: lead-magnet campaigns return lm_stats (captured / DMs / replies / booked) instead of outreach rates; retargeting/re_engagement campaigns return re_stats (enrolled / messaged / replied / positive / booked - no requests/accepted; messaged also counts a lead who messaged in first, before their drip fired); pure-InMail campaigns (a send_inmail step with no connection_request) return inmail_stats (sent / replies / open-profile rate / skip reasons), always all-time regardless of days_back. booking_rate = meetings booked / positive replies for outreach and retargeting campaigns, and meetings booked / replies for lead-magnet campaigns; the InMail shape has no booking_rate or meetings_booked field at all. Use when the user names a SPECIFIC campaign; use getCampaigns for overviews. If the campaign runs an A/B split, the result includes per-variant contacted/accepted/replied - narrate which arm leads and whether the sample is big enough to trust; the A/B block always stays all-time regardless of days_back.

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/getCampaignStats

Request

  • Base URL: https://app.reachium.io
  • URL: https://app.reachium.io/api/v1/actions/getCampaignStats
  • 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

namestring required

A substring of the campaign name to search for (case-insensitive). E.g. "lead magnet" or "Q1".

days_backinteger

Window the stats to the last N days. Omit for all-time.

Response

The result of calling this tool.

dataunknown required
errorunknown required

Changes

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