Automations

Automation statistics per automation

E-mails and runs per automation. Call it to compare automations or to read the numbers of several at once.

With automation_ids (up to 100, ids from list_automations): every listed live automation of the site in the order given, zeros without activity; repeated ids count once, unknown, deleted and foreign ids and follow-ups of widgets are left out. The period is optional here: without from and to the numbers cover the whole life, and period is null.

Without automation_ids the period is required: up to 100 live automations with activity in the period, by the sum of runs, then by send, most first. Deleted automations and follow-ups of widgets are left out, so the sum may be below the total of get_automations_stats.

is_active, trigger_type, widget_id, search, created_since and folder_id narrow either way to the automations that match every one given, and then every matched automation is listed, zero ones too: one call gives the numbers of a folder or of the active automations. total and runs are the sums of the listed automations; use them rather than adding the items up.

E-mails of an automation are those sent by its steps; double opt-in confirmations are counted only in the site total.

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/by-automation

Request

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

Path parameters

site_idinteger required

Query parameters

automation_idsinteger[]

Automation ids from list_automations; repeat for several, up to 100

fromstring date

UTC day, included; omit for the whole life

tostring date

UTC day, included; with from, today when omitted

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.