FluentCRM Developers

Appearance

View as Markdown

GET Automation Reports​

GET
/reports/automations

Paginated performance summary for every published automation, newest first. Drafts are excluded.

The four progression counts (total_subscribers, completed_count, in_progress_count, last_run_at) are produced by a single grouped aggregate across the whole page rather than per-row queries, so page size does not multiply query count.

::: warning
This endpoint's aggregate is built with selectRaw(), which bypasses the prefix-adding query grammar. It is one of the two seed cases in the plugin's test suite — see tests/smoke/routes.manifest.php.
:::

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

per_page

Automations per page.

Type
integer
Default
15
page

Page number.

Type
integer
Default
1

Responses​

Paginated automation reports.

application/json
JSON
{
"automations": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"from": 0,
"to": 0,
"next_page_url": "string",
"prev_page_url": "string",
"data": [
{
"id": 0,
"type": "string",
"title": "string",
"trigger_name": "string",
"status": "string",
"conditions": {
},
"settings": {
},
"created_by": "string",
"created_at": "string",
"updated_at": "string",
"total_subscribers": 0,
"completed_count": 0,
"in_progress_count": 0,
"last_run_at": "string",
"recent_subscribers": [
{
}
]
}
]
},
"overview": {
"total": 0,
"subscribers": 0,
"completed": 0,
"in_progress": 0
},
"top_automations": [
{
"id": "string",
"title": "string",
"trigger_name": "string",
"trigger_count": 0
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI