Newsman – Knowledge Base
Newsman Api Method: transactional.accountTagStats
Prototype: transactional.accountTagStats(list_id, tag, start_date, stop_date, unit, account_id)
Description: Returns stats for a tag in a given period, grouped by unit
HTTP method: GET
Endpoint HTTP: /transactional.accountTagStats.json
Endpoint XML-RPC: transactional.accountTagStats
Return type: arrayReturn info: Struct containing the stats for a tag between “start_date” and “stop_date” grouped by “unit”
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| list_id | int|string | The ID of the list from which to identify the SMTP account |
| tag | string | The name of the tag for which to fetch stats. |
| start_date | string | The start of the period for which to fetch the stats (date or datetime). |
| stop_date | string | The stop of the period for which to fetch the stats (date or datetime). |
| unit | string | The group method. Can be either days or hours. |
| account_id | string|boolean | The id of a specific SMTP ACCOUNT from which to fetch the stats (optional). |
Response parameters
| Parameter | Description |
|---|---|
| struct | dict containing stats for a tag between “start_date” and “stop_date” grouped by “unit”. The dict contains the following keys: spam, bounce, click, send, reject, unsub, hardbounce and view. Each dict item contains an array of dicts, each subdict has dates in YYYY-MM-DD format as keys. If the unit is hours, a subkey is added for each hour (0-23). |
Output example
{ "spam": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } }, "bounce": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } }, "click": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } }, "send": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } }, "reject": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } }, "unsub": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } }, "hardbounce": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } }, "view": { "2024-11-13": { "total": 0, "utotal": 0 }, "2024-11-15": { "total": 0, "utotal": 0 }, "2024-11-14": { "total": 0, "utotal": 0 }, "2024-11-17": { "total": 0, "utotal": 0 }, "2024-11-16": { "total": 0, "utotal": 0 }, "2024-11-18": { "total": 0, "utotal": 0 } } }
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 |
| 17003 | Could not find the SMTP account | Transactional account not found |
| 17004 | The SMTP account is inactive | The transactional account is inactive |
| 17014 | The tag stats could not be fetched: [error_reason] | The stats could not be fetched |
Error examples
{ "err": true, "message": "Missing required param list_id", "code": 407 }
{ "err": true, "message": "Could not find the SMTP account", "code": 17003 }
{ "err": true, "message": "The SMTP account is inactive", "code": 17004 }
{ "err": true, "message": "The tag stats could not be fetched: [error_reason]", "code": 17014 }