Newsman – Knowledge Base
Metoda API Newsman: transactional.accountTagStats
Prototip: transactional.accountTagStats(list_id, tag, start_date, stop_date, unit, account_id)
Descriere: Întoarce statistici pentru un tag într-o anumită perioadă, grupate după unit
Metoda HTTP: GET
Endpoint HTTP: /transactional.accountTagStats.json
Endpoint XML-RPC: transactional.accountTagStats
Tip raspuns: arrayInformatii raspuns: Struct conținând statisticile pentru un tag între "start_date" și "stop_date" grupate după "unit"
Parametrii request GET
| Variabila | Tip | Descriere |
|---|---|---|
| list_id | int|string | ID-ul listei pe baza căreia va fi identificat contul SMTP |
| tag | string | Numele tag-ului pentru care vor fi preluate statistici. |
| start_date | string | Începutul perioadei pentru care să se preia statistici (date sau datetime). |
| stop_date | string | Sfârșitul perioadei pentru care să se preia statistici (date sau datetime). |
| unit | string | Metoda de grupare. Poate fi days sau hours. |
| account_id | string|boolean | ID-ul unui anumit cont SMTP din care să fie preluate statisticile (opțional). |
Parametrii raspuns
| Parametru | Descriere |
|---|---|
| struct | dict conținând statisticile pentru un tag între "start_date" și "stop_date" grupate după "unit". Fiecare dict conține următoarele chei: spam, bounce, click, send, reject, unsub, hardbounce și view. Fiecare item din dict conține un array, fiecare subitem având ca și chei date în format YYYY-MM-DD. Dacă unit este hours, o subcheie este adăugată pentru fiecare oră (0-23). |
Exemple request
Exemplu output
{ "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 } } }
Erori raspuns
| Cod | Mesaj | Descriere |
|---|---|---|
| 407 | Missing required param list_id | Parametrul list_id este obligatoriu |
| 101 | Not allowed for list_id = %s | Acces nepermis la list_id |
| 17001 | Invalid message | Valoarea parametrului message este invalidă |
| 17003 | Could not find the SMTP account | Nu a fost găsit contul SMTP |
| 17004 | The SMTP account is inactive | Contul SMTP este inactiv |
| 17014 | The tag stats could not be fetched: [error_reason] | Statisticile nu au putut fi preluate |
Exemple de erori
{ "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 }