Get campaign stats
Delivery and engagement stats for a campaign. Rates are percentages rounded to one decimal.
GET
https://api.centerfy.ai/webhooks/inbound/campaigns/:id/stats Headers
| Header | Required | Value | Description |
|---|---|---|---|
x-api-key | Yes | your sub-account API key (cfy_…) | Authenticates the request; or use Authorization: Bearer <key>. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | The campaign id. |
Example
curl -X GET "https://api.centerfy.ai/webhooks/inbound/campaigns/{id}/stats" \
-H "x-api-key: $CENTERFY_API_KEY" import { CenterfyClient } from "@centerfy/sdk";
const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });
const result = await centerfy.campaigns.stats("<campaignId>");
console.log(result); centerfy campaigns stats <campaignId> MCP tool: centerfy_campaigns_stats (see MCP server)
Response
{
"status": "success",
"campaign_id": "4b7e1c2d-3a4f-4e5d-9c8b-7a6f5e4d3c2b",
"campaign_type": "email",
"campaign_status": "completed",
"progress": 100,
"recipients": 2,
"contacted": 2,
"delivered": 2,
"failed": 0,
"pending": 0,
"success_rate": 100,
"delivery_rate": 100,
"engagement": {
"opened": 1,
"clicked": 1,
"unsubscribed": 0,
"open_rate": 50,
"click_rate": 50,
"unsubscribe_rate": 0
}
}Errors
404— if the campaign is not in this sub-account.
Notes
success_rate is delivered ÷ recipients and delivery_rate is contacted ÷ recipients. engagement is null for SMS campaigns; for email its rates are relative to delivered.