Sign in
Automations

Automation portfolio stats for one shop

Shop-level overview of your automations: total_automations, live_automations, archived_automations, and the split between regular_automations and email_automations, plus three breakdowns — by_type (Target Collab, Message, Email, Sample Request Processing, …), by_status (running / stopped / completed / …) and by_type_and_state (each type split live vs archived) — and an aggregated metrics block rolled up across the shop's automations.

This is the portfolio view; use POST /automations/list for the per-automation rows behind it. Pass crm_only=true to count only automations backed by a CRM group. Single-shop only.

get/automations/stats

Query parameters

crm_onlyboolean

Count only CRM-backed automations (those with a crm_group_id). Defaults to false — all automations.

Count only CRM-backed automations (those with a crm_group_id). Defaults to false — all automations.

Response

Successful Response

total_automationsinteger required

Total number of automations (regular + email)

live_automationsinteger required

Number of live (active) automations

archived_automationsinteger required

Number of archived automations

email_automationsinteger required

Number of email automations

regular_automationsinteger required

Number of regular (non-email) automations

by_typeobject required

Count of automations by type (includes 'Email' for email automations)

by_statusobject required

Count of automations by status

by_type_and_stateobject required

Count of automations by type and state (live/archived)

Changes

No recorded changes to this endpoint across all 1 revision of this API.