Skip to content
View as Markdown

GET Automation Step Report​

GET
/reports/automations/{id}/steps

Funnel-shaped drop-off report for a single automation: how many contacts reached each step, and how many were lost between steps.

stats always opens with a synthetic Entrance row (sequence_id: 0, type: "root") holding the distinct entrant count, which every later step is measured against. Steps that no contact has reached are omitted entirely, so stats is not a complete list of the automation's steps.

percent is clamped to 100 while percent_text keeps the uncapped value, so a step re-entered by the same contact can read above 100 in the label but not in the bar.

stats is an empty array when the automation has no steps — that is a valid response, not an error.

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​

Path Parameters

id*

Funnel (automation) id.

Type
integer
Required

Responses​

The automation and its per-step funnel.

application/json
JSON
{
"funnel": {
"id": 0,
"type": "string",
"title": "string",
"trigger_name": "string",
"status": "string",
"conditions": {
},
"settings": {
},
"created_by": "string",
"created_at": "string",
"updated_at": "string"
},
"stats": [
{
"label": "string",
"count": 0,
"sequence_id": 0,
"type": "string",
"percent": 0,
"percent_text": 0,
"previous_step_count": 0,
"drop_count": 0,
"drop_percent": 0
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI