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 Stats​

GET
/reports/messaging-stats

Return time series for the Messaging report charts: one zero-filled, date-keyed object per requested metric. The bucket size (daily, weekly or monthly) follows the length of the date range, as in the email report charts.

opt_outs counts only inbound keyword opt-outs (such as a STOP reply). Opt-outs made from the inbox or a contact profile are not counted, because consent changes carry no timestamp.

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"
metrics

Metrics to return. Unknown names are ignored; if none are left, all four are returned.

Type
array

Responses​

One series per requested metric.

application/json
JSON
{
"stats": {
"additionalProperties": {
"additionalProperties": 0
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI