Skip to content
View as Markdown

GET Get Campaign Processing Stat​

GET
/campaigns/{id}/processing-stat

Get the current processing status and statistics of a campaign being sent. This endpoint is polled during campaign sending to track progress. It processes a chunk of emails on each call and returns the updated campaign state, including whether the campaign has finished processing.

::: warning TWO RESPONSE SHAPES
This endpoint returns different keys depending on campaign state. While the campaign is processing you get campaign, didRun, and scheduling_method. Once it is not, you get reload: true and campaign instead — and no didRun or scheduling_method. Branch on the presence of reload.
:::

Polling this endpoint is what advances the send: each call processes a chunk of emails (30 by default, for up to 10 seconds) before returning. It is a worker tick, not a read-only status probe.

Required capability: fcrm_read_emails

Enforced by CampaignPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The campaign ID.

Type
integer
Required

Responses​

Processing statistics retrieved.

application/json
JSON
{
"campaign": {
"id": 3,
"status": "processing",
"recipients_count": 628
},
"didRun": true,
"scheduling_method": "action_scheduler"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI