Automations

Automation statistics

E-mails and runs of one automation. Without from and to they cover its whole life, and period is null. E-mails are counted by the automation that sent them, including e-mails since removed from it. Clicks by link: get_automation_clicks.

A new run through run_automation of a contact whose run failed replaces that failure, so failed of a past period may go down. A bulk start shows in runs.queued only once it is split into runs.

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/{automation_id}/stats

Request

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

Path parameters

site_idinteger required
automation_idinteger required

Automation id from list_automations

Query parameters

fromstring date

UTC day, included; omit for the whole life

tostring date

UTC day, included; with from, today when omitted

Response

Successful Response

Changes

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