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 Campaign Calendar​

GET
/reports/campaign-calendar

List every campaign dated inside a date range, for the Reports calendar. The list covers email campaigns, emails sent by recurring campaigns plus each recurring campaign's next run, and, when Messaging is enabled, campaigns on the active messaging channels.

A campaign is dated by scheduled_at, or by created_at when it has no schedule, so an unscheduled draft appears on the day it was created. The range is capped at 366 days from its start. Rows are sorted by date, then by id.

status folds the raw campaign status into one of draft, scheduled, sent, failed or cancelled. In-flight states such as pending, working and paused, and an active recurring campaign, count as scheduled. A status FluentCRM does not map is returned unchanged. raw_status always holds the stored value.

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
types

Campaign types to include: email and/or a messaging channel slug. Omit for all types. A channel that is not active is ignored.

Type
array

Responses​

Campaigns dated inside the range.

application/json
JSON
{
"campaigns": [
{
"id": 0,
"parent_id": 0,
"type": "string",
"kind": "string",
"title": "string",
"status": "string",
"raw_status": "string",
"date": "string",
"recipients": 0
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI