Newsman – Knowledge Base
Metoda API Newsman: newsletter.all
Prototip: newsletter.all(list_id, start_date, stop_date, status, start, limit, days)
Descriere: Returnează o listă cu newslettere având status $status între $start_date, $stop_date (inclusiv). Metoda poate de asemenea să intoarcă rezultate în format CSV folosind CSV output format: newsletter.all.csv
Metoda HTTP: GET
Endpoint HTTP: /newsletter.all.json
Endpoint XML-RPC: newsletter.all
Tip raspuns: structInformatii raspuns: Array cu newslettere. Fiecare element este un array cheie / valoarea având cheile: newsletter_id, subject, segments, skip_segments, status, create_date, send_date, stats, view_online_link, visual_report_link, preview.
Parametrii request GET
| Variabila | Tip | Descriere |
|---|---|---|
| list_id | string|int | ID-ul listei pentru care se dorește preluarea newsletterelor |
| start_date | datetime|string|boolean | Începutul perioadei în care a fost creat newsletter-ul |
| stop_date | datetime|string|boolean | Sfârșitul perioadei în care a fost creat newsletter-ul |
| status | boolean|int|string | Status-ul poate fi:
|
| start | string|int | Opțional, pentru liste mari. Numărul paginii de început. Implicit este prima pagină (page = 0). |
| limit | string|int | Opțional, pentru liste mari. Numărul de rezultate per pagină. Implicit este 100. Nu poate depăși 1000 |
| days | string|int|boolean | Opțional, caută pentru ultimele zile specificate de valoare (ex: 90). Poate fi folosit ca o alternativă pentru start_date și stop_date. |
Parametrii raspuns
| Parametru | Descriere |
|---|---|
| newsletter_id | Id-ul newsletter-ului |
| subject | Subiectul newsletter-ului |
| segments | Segmentele newsletter-ului (dacă există, array conținand perechi cheie / valoare având segment_id ca și cheie) |
| skip_segments | Segmentele excluse ale newsletter-ului (dacă există, array conținand perechi cheie / valoare având segment_id ca și cheie) |
| status | Status-ul newsletter-ului |
| create_date | Data creării |
| send_date | Data trimiterii |
| stats | Array având statistici (unique_views, total_views, unique_view_rate, unique_clicks, total_clicks, unique_click_rate, ctor, total_sent, sent_per_minute, send_duration_minutes, unsubcribes, unsubscribe_rate, spam_reports, spam_reports_rate, bounces, bounce_rate, mobile_unique_opens, mobile_unique_open_rate, ecommerce - array având cheile no_orders, revenue_ron, revenue_eur) |
| view_online_link | Link-ul de vizualizare online |
| visual_report_link | Link-ul de heatmap click-uri |
| preview | Array conținând preview-ul newsletter-ului. Cheile sunt: thumb, full |
Exemple request
Exemplu output
[ { "newsletter_id": "80001", "subject": "Some subject here", "segments": "[{\"segment_id\":\"2001\",\"segment_name\":\"Test Segment\"}]", "status": "-1", "create_date": "2017-03-14 17:35:32", "stats": { "unique_views": 0, "total_views": 0, "unique_view_rate": 0, "unique_clicks": 0, "total_clicks": 0, "unique_click_rate": 0, "total_sent": 0, "sent_per_minute": 0, "unsubcribes": 0, "spam_reports": 0, "bounces": 0 }, "view_online_link": "the_view_online_link", "visual_report_link": "the_visual_report_link" }, { "newsletter_id": "80002", "subject": "Some other subject here", "segments": "[{\"segment_id\":\"2002\",\"segment_name\":\"Test Segment 2\"}]", "status": "-1", "create_date": "2017-03-13 17:35:32", "stats": { "unique_views": 0, "total_views": 0, "unique_view_rate": 0, "unique_clicks": 0, "total_clicks": 0, "unique_click_rate": 0, "total_sent": 0, "sent_per_minute": 0, "unsubcribes": 0, "spam_reports": 0, "bounces": 0 }, "view_online_link": "the_view_online_link", "visual_report_link": "the_visual_report_link" } ]
Erori raspuns
| Cod | Mesaj | Descriere |
|---|---|---|
| 407 | Missing required param list_id | Parametrul list_id este obligatoriu |
| 407 | Missing required param start_date | Parametrul start_date este obligatoriu |
| 407 | Missing required param stop_date | Parametrul stop_date este obligatoriu |
| 407 | Missing required param status | Parametrul status este obligatoriu |
| 407 | Missing required param start | Parametrul start este obligatoriu |
| 407 | Missing required param limit | Parametrul limit este obligatoriu |
| 101 | Not allowed for list_id = %s | Acces nepermis la list_id |
Exemple de erori
{ "err": true, "message": "Missing required param list_id", "code": 407 }
{ "err": true, "message": "Missing required param start_date", "code": 407 }
{ "err": true, "message": "Missing required param stop_date", "code": 407 }
{ "err": true, "message": "Missing required param status", "code": 407 }
{ "err": true, "message": "Missing required param limit", "code": 407 }