FluentCRM Developers

Appearance

View as Markdown

GET Top Campaigns​

GET
/reports/top-campaigns

Best-performing sent campaigns, ranked by open rate, click rate, or volume.

Only rows where all of the following hold are counted: campaign status archived, campaign type campaign, and email status sent. Recurring campaigns, sequence emails, and automation emails are therefore excluded by design.

open_rate and click_rate are percentages computed in SQL and come back as strings with full decimal precision (for example "84.7134"), as does total_sent. Round them client-side.

An unrecognised sort_by silently falls back to open_rate rather than erroring.

Required capability: fcrm_manage_settings

Enforced by SettingsPolicy::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

sort_by

Ranking metric. Unrecognised values fall back to open_rate.

Type
string
Valid values
"open_rate""click_rate""total_sent"
Default
"open_rate"
per_page

Maximum number of campaigns to return.

Type
integer
Default
10

Responses​

Ranked campaigns.

application/json
JSON
{
"campaigns": [
{
"id": "string",
"title": "string",
"updated_at": "string",
"total_sent": "string",
"open_rate": "string",
"click_rate": "string"
}
],
"available": true
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI