Skip to content
View as Markdown
Enter your site to enable Send. Requests are sent from your browser, so the site must allow cross-origin calls (CORS).

GET Messaging Performance​

GET
/reports/messaging-performance

Return the stat-card totals for the Messaging report over a date range: outbound messages sent, delivered and failed, and inbound messages received. Messages are dated by their activity time.

attempted is sent plus failed. The delivered percentage is relative to sent; the failed percentage is relative to attempted. Both are 0 when their base is 0.

Returns 404 when the Messaging module is off.

Required capability: fcrm_read_emails or fcrm_manage_emails — which one applies depends on the action being performed.

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

Requires: FluentCampaign Pro. Without it the route does not exist.

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​

Query Parameters

date_range

Date range as a two-element array [from, to] in YYYY-MM-DD format, read in the site timezone. Defaults to the last 30 days if omitted.

Type
array
Min Items
2
Max Items
2
channel

Limit the figures to one messaging channel. Omit, or send an unknown value, for all channels.

Type
string
Valid values
"sms""whatsapp"

Responses​

Messaging totals for the range.

application/json
JSON
{
"stats": {
"totals": {
"attempted": 0,
"sent": 0,
"delivered": 0,
"failed": 0,
"received": 0
},
"percentages": {
"delivered": 0,
"failed": 0
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI