Skip to content
View as Markdown

GET Email Unsubscribe Stats​

GET
/reports/email-unsubs

Daily unsubscribe counts for a date range, ready to plot as a time series.

stats is a map keyed by date (YYYY-MM-DD), not an array. Every day in the range is present, including days with no unsubscribes, so the series has no gaps.

date_range is a two-element array: date_range[0] is the start and date_range[1] the end. Omitting it falls back to the reporting service's default window.

Required capability: fcrm_view_dashboard

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

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[]

Two-element range as [from, to], each YYYY-MM-DD. Omit for the default window.

Type
array

Responses​

Unsubscribes per day.

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

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI