Newsman – Knowledge Base
Newsman Api Method: automation.stats
Prototype: automation.stats(list_id, workflow_ids, trigger_id, start_date, stop_date, days, month)
Description: Returns stats, grouped by days, for workflows between $start_date, $stop_date (inclusive)
HTTP method: GET
Endpoint HTTP: /automation.stats.json
Endpoint XML-RPC: automation.stats
Return type: structReturn info: Array with stats grouped by days. Each array item represents stats for a date and is a hash with keys: date, sends_unique, sends_total, opens_unique, opens_total, clicks_unique, clicks_total, purchase_count, purchases_value_ron, purchases_value_eur, bounce_total, unsub_total, spam_total, events_ok, events_failed, conditions_ok, conditions_failed, actions_ok, actions_failed, currency, formatted_revenue_ron, formatted_revenue_eur, purchases_value_aov_ron, formatted_value_aov_ron, purchases_value_aov_eur, formatted_value_aov_eur, opens_unique_percent, clicks_unique_percent
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| list_id | string|int | The ID of the list for which to get the workflows |
| workflow_ids | array|string|boolean | Optional, ids to filter stats from certain workflows (array or string with comma-separated ids). If missing stats will be fetched for all the workflows in the list. |
| trigger_id | int|string|boolean | Optional, The id of a specific workflow trigger for which to filter the stats |
| start_date | string|boolean | Optional, Start of the period for which to fetch the stats |
| stop_date | string|boolean | Optional, End of the period for which to fetch the stats |
| days | string|int|boolean | Optional, searches for the last days specified by the value (eg: 90). Can be used as an alternative for start_date and stop_date. |
| month | string|int|boolean | Optional, the period is defined by the month (eg: 5 or 2025-05). Can be used as an alternative for start_date and stop_date |
Response parameters
| Parameter | Description |
|---|---|
| sends_unique | No. of unique sends |
| sends_total | No. of total sends |
| opens_unique | No. of unique opens |
| opens_total | No. of total opens |
| clicks_unique | No. of unique clicks |
| clicks_total | No. of total clicks |
| purchase_count | No. of purchases |
| purchases_value_ron | Total value of purchases placed in RON |
| purchases_value_eur | Total value of purchases placed in EUR |
| bounce_total | No. of bounces |
| unsub_total | No. of unsubscribes |
| spam_total | No. of spam reports |
| events_ok | No. of events which executed |
| events_failed | No. of events which did not execute (eg: canceled for rescheduling) |
| conditions_ok | The no. of events for which conditions which were fulfilled |
| conditions_failed | The no. of events for which conditions failed evaluation |
| actions_ok | The no. of actions which executed succesfuly |
| actions_failed | The no. of actions which failed (eg: error occured) |
| date | The date on which the stats were grouped |
| formatted_revenue_ron | The formatted total value of purchases placed in RON |
| formatted_revenue_eur | The formatted total value of purchases placed in EUR |
| purchases_value_aov_ron | The average order value for purchases placed in RON |
| formatted_value_aov_ron | The formatted average order value for purchases placed in RON |
| purchases_value_aov_eur | The average order value for purchases placed in EUR |
| formatted_value_aov_eur | The formatted average order value for purchases placed in RON |
| opens_unique_percent | The open rate |
| clicks_unique_percent | The click rate |
| list_id | The list_id to which the workflows, for which the stats were collected, belong |
Request examples
Output example
[ { "sends_unique": 20, "sends_total": 20, "opens_unique": 7, "opens_total": 13, "clicks_unique": 4, "clicks_total": 6, "purchase_count": 2, "purchases_value_ron": 4412.93, "purchases_value_eur": 0, "bounce_total": 1, "unsub_total": 1, "spam_total": 0, "events_ok": 97, "events_failed": 0, "conditions_ok": 21, "conditions_failed": 16, "actions_ok": 20, "actions_failed": 1, "date": "2025-06-01", "currency": "RON", "formatted_revenue_ron": "4412,93", "formatted_revenue_eur": "0,00", "purchases_value_aov_ron": 329.49, "formatted_value_aov_ron": "329,50", "purchases_value_aov_eur": 0, "formatted_value_aov_eur": "0,00", "opens_unique_percent": 35, "clicks_unique_percent": 20, "list_id": "the_list_id" }, { "sends_unique": 25, "sends_total": 25, "opens_unique": 13, "opens_total": 22, "clicks_unique": 3, "clicks_total": 5, "purchase_count": 2, "purchases_value_ron": 3545.93, "purchases_value_eur": 0, "bounce_total": 2, "unsub_total": 0, "spam_total": 1, "events_ok": 134, "events_failed": 0, "conditions_ok": 27, "conditions_failed": 26, "actions_ok": 25, "actions_failed": 1, "date": "2025-06-02", "currency": "RON", "formatted_revenue_ron": "3545,93", "formatted_revenue_eur": "0,00", "purchases_value_aov_ron": 163.9, "formatted_value_aov_ron": "163,90", "purchases_value_aov_eur": 0, "formatted_value_aov_eur": "0,00", "opens_unique_percent": 52, "clicks_unique_percent": 12, "list_id": "the_list_id" } ]
Response Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param list_id | list_id param is required |
| 101 | Not allowed for list_id = %s | Invalid access to list_id |
Error examples
{ "err": true, "message": "Missing required param list_id", "code": 407 }