30 days free. No credit card. Full access from the moment you connect your site.

Start free trial

MailerPress Get Campaign Status Summary

mailerpress/get-campaign-status-summary returns, for a list of campaign IDs, the current status, batch state and statistics — opens, clicks, unsubscribes and revenue.

One round trip replaces several separate calls.

At a glance

Abilitymailerpress/get-campaign-status-summary
ToolsetMailerPress — toolset/mailerpress
GroupMailerPress › Campaigns & Sending
RequiresAcrossAI Pro, plus MailerPress active on the site
Capabilitymanage_options
SafetyRead-only — changes nothing
RepeatableIdempotent — running it twice leaves the same result
Ships inAcrossAI Pro 0.9.16 and later

How it works

The addition over the plain statistics read is status and batch state, which turn a performance number into a situation: a campaign with low opens and a stalled batch has not underperformed, it has not finished sending.

Revenue is the other addition, and it is WooCommerce-attributed — a purchase traced back to a click in that campaign. It exists only on sites with the integration and only where tracking was on.

MailerPress returns a bare array here; the response is wrapped into an object so callers do not have to special-case the shape.

This is the monitoring read: one call covering a set of recent campaigns, answering both “did they send” and “did they work”.

Input

NameTypeRequiredWhat it is
idsstringYesComma-separated campaign IDs.

What comes back

NameTypeWhat it is
campaignsarrayPer campaign: status, batch state, opens, clicks, unsubscribes and revenue.
successbooleanWhether the call completed.
messagestringA one-line summary of what happened, suitable for showing a human.
error_codestringPresent only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation.

Example

Ask your assistant:

How are this month’s campaigns doing?

It resolves to one call:

{
  "ability": "mailerpress/get-campaign-status-summary",
  "parameters": {
    "ids": "44,45,46"
  }
}

Worth knowing

  • Status plus statistics distinguishes underperforming from unfinished.
  • Revenue needs WooCommerce and tracking enabled.
  • The bare array is wrapped so callers do not special-case it.
  • The monitoring read.

Related abilities


Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager

Browse the rest: Every ability, by category


Keep reading