NewsMAN API: sms.allCampaigns

Sectiuni

Newsman – Knowledge Base

HomeAPISmssms.allCampaigns

Metoda API Newsman: sms.allCampaigns

Prototip: sms.allCampaigns(list_id, start_date, stop_date, status, start, limit)

Descriere: Returnează o listă cu campanii având status $status între $start_date, $stop_date (inclusiv)

Metoda HTTP: GET

Endpoint HTTP: /sms.allCampaigns.json

Endpoint XML-RPC: sms.allCampaigns

Tip raspuns: struct

Informatii raspuns: Array cu campanii. Fiecare element este un array cheie / valoarea având cheile: campaign_id, subject, status, create_date, stats, view_online_link, visual_report_link, segments

Parametrii request GET

Variabila	Tip	Descriere
list_id	string\|int	ID-ul listei pentru care se dorește preluarea campaniilor
start_date	datetime\|string\|boolean	Începutul perioadei în care a fost creată campania
stop_date	datetime\|string\|boolean	Sfârșitul perioadei în care a fost creată campania
status	boolean\|int\|string	Status-ul poate fi: all - toate newsletterele -1 - anulat 0 - neconfirmat (nou) 1 - confirmat 2 - se trimite 3 - pauză 4 - repornit 5 - trimis o combinație separată prin virgulă din status-urile anterioare, ex: 1,5
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ăsi 1000

Parametrii raspuns

Parametru	Descriere
campaign_id	Id-ul campaniei
subject	Subiectul campaniei
segments	Segmentele campaniei (dacă există, array conținand perechi cheie / valoare având segment_id ca și cheie)
status	Status-ul campaniei
create_date	Data creării
stats	Array având statistici (ex: unique_views, unique_clicks)
view_online_link	Link-ul de vizualizare online
visual_report_link	Link-ul de heatmap click-uri

Exemplu output

[
    {
        "campaign_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
}