Automations

Site automation statistics

E-mails and runs of the automations of the site in the period, summed. Without filters the count covers the whole site: deleted automations and follow-ups of widgets are included, and e-mails are those sent by the steps of automations, by follow-ups of widgets and as double opt-in confirmations. With a filter, follow-ups of widgets, deleted automations and double opt-in confirmations are not counted. runs counts the runs started in the period, each by its current status. automation_ids, is_active, trigger_type, widget_id, search, created_since and folder_id narrow the count to the live automations that match every one given, and then the e-mails are those sent by their steps; matched says how many, and matched: 0 means no automation matched.

Per automation: get_automations_stats_by_automation; over time: get_automations_stats_timeline; one automation: get_automation_stats.

rates next to each total gives the delivery, open, click, click-to-open, unsubscribe, complaint and bounce rates of the e-mails, rounded to 4 places; a rate is null when its denominator is 0, as it is undefined, not zero.

get/v1/sites/{site_id}/automations/stats

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required

Query parameters

fromstring date required

First day of the period, UTC, included

tostring date

Last day of the period, UTC, included; today when omitted

automation_idsinteger[]

Only these automation ids from list_automations, up to 100; repeat for several

is_activeboolean

true: only automations that are on; false: off

trigger_typeAutomationTriggerType[]

Only automations started by any of these trigger types; repeat for several

widget_idinteger

Only automations started by a form submit of this widget; widget id from list_widgets

searchstring

Words of the name in order; case, spacing and punctuation are ignored. Or the exact id

created_sincestring date-time

Only automations created at or after this moment; without an offset, taken as UTC; a plain date means its start

folder_idinteger

Only the items of this folder, an id from list_folders; 0 is General

Response

Successful Response

matchedinteger nullable

How many live automations the filters or ids matched; null without them. 0 means nothing matched, not that nothing happened: check the filters or ids

Changes

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