Newsman – Knowledge Base
Metoda API Newsman: transactional.accountHistory
Prototip: transactional.accountHistory(list_id, date, action_type, count, before_timestamp, tag, account_id)
Descriere: Întoarce un array cu acțiuni, sortate în ordine descrescătoare, pentru un cont SMTP
Metoda HTTP: GET
Endpoint HTTP: /transactional.accountHistory.json
Endpoint XML-RPC: transactional.accountHistory
Tip raspuns: arrayInformatii raspuns: Array conținând acțiuni, sortate în ordine descrescătoare, pentru un cont SMTP
Parametrii request GET
| Variabila | Tip | Descriere |
|---|---|---|
| list_id | int|string | ID-ul listei pe baza căreia va fi identificat contul SMTP |
| date | string | Dacă se folosește, trebuie să fie în format YYYY-mm-dd în timezone-ul local și limitează rezultatele la acea zi specifică (ex: folositor pentru listări pe zile). Dacă nu se trimite, se folosește doar "before_timestamp". (opțional) |
| action_type | string | Limitare rezultate la o acțiune specifică. Poate fi send, view, click, unsub, bounce, spam, reject (opțional) |
| count | string|int | Limitare număr de rezultate (trebuie să fie între 50 și 10000). Default: 50 |
| before_timestamp | string|int | Timestamp (seconds since epoch) folosit pentru a naviga printre rezultate. Dacă nu se trimite se folosește timestamp-ul curent. (opțional) |
| tag | string|int | Limitare rezultate la acest tag (opțional) |
| account_id | string|boolean | ID-ul unui anumit cont SMTP din care să fie preluat istoricul (opțional). |
Parametrii raspuns
| Parametru | Descriere |
|---|---|
| array | array cu acțiuni, sortate în ordine descrescătoare, pentru un cont SMTP |
Exemplu output
[ { "action": "send", "timestamp": 1731687291, "data": { "meta": { "subject": "test subject" }, "send_id": "the_send_id", "email": "john1@example.com" } }, { "action": "send", "timestamp": 1731687240, "data": { "meta": { "subject": "test subject" }, "send_id": "the_send_id_2", "email": "john2@example.com" } }, { "action": "send", "timestamp": 1731682493, "data": { "meta": { "subject": "test subject" }, "send_id": "the_send_id_3", "email": "john3@example.com" } } ]
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 |
| 17016 | The account history could not be fetched: [error_reason] | Istoricul nu a putut fi preluat |
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 account history could not be fetched: [error_reason]", "code": 17016 }