Kontroler służy do pobierania raportów oraz list wysłanych kampanii.

Pobieranie listy wysłanych kampanii

Wywołanie:
GET /rest/reports/campaignsList/[page]

 

Dane w GET:

page	Opcjonalne	Numer strony z kampaniami, domyślnie pobierana jest pierwsza strona

W odpowiedzi serwer zwróci listę 25 kampanii.

 

Zwracane dane:

name	Nazwa kampanii
topic	Temat emaila w kampanii
subscribers	Ilość subskrybentów do których była wysyłka
id_hash	Unikalny identyfikator kampanii
sent	Data wysyłki kampanii, format: rrrr-mm-dd hh:ii:ss

 

 

Pobieranie zbiorczego raportu z kampanii

Wywołanie:

GET/rest/reports/campaign/[id_hash]

 

Dane w GET:

id_hash	Wymagane	Unikalny identyfikator kampanii, można go otrzymać wywołując metodę /rest/reports/campaignsList

 

Zwracane dane:

subscribers	Liczba wszystkich subskrybentów do których wysłano kampanię
delivered	Liczba dostarczonych wiadomości
hard_bounce	Liczba wiadomości odbitych „twardo” (http://www.ietf.org/rfc/rfc1893.txt)
soft_bounce	Liczba wiadomości odbitych „miękko” (http://www.ietf.org/rfc/rfc1893.txt)
opened	Liczba wszystkich otwartych wiadomości
clicked	Liczba wszystkich kliknięć w danym przedziale czasowym
unique_opened	Liczba unikalnych otwarć wiadomości
unique_clicked	Liczba unikalnych klikniętych wiadomości
resigned	Liczba wypisanych subskrybentów

Pobieranie zachowań subskrybentów w czasie

Wywołanie:

GET /rest/reports/campaignTimeDetails/[id_hash]

 

Dane w GET:

id_hash	Wymagane	Unikalny identyfikator kampanii, można go otrzymać wywołując metodę /rest/reports/campaignsList

 

Zwracane dane:

tablica z kolejnymi działaniami subskrybentów w czasie:

{"status":"OK","data":
[
{"opened":"4",
"unique_opened":"4",
"clicked":"3",
"unique_clicked":"1",
"time":"2012-03-26 16:50"},
{"opened":"1",
"unique_opened":"1",
"clicked":"1",
"unique_clicked":"1",
"time":"2012-03-27 08:30"}
]
}

 

opened	Liczba wszystkich otwarć w danym przedziale czasowym
clicked	Liczba wszystkich kliknięć w danym przedziale czasowym
unique_opened	Liczba unikalnych otwartych emaili w danym przedziale czasowym
sunique_clicked	Liczba unikalnych emaili z klikniętym linkiem w danym przedziale czasowym
time	Czas w formacie „rrrr-mm-dd HH:ii”, rozdzielczość okna to 10 minut

 

Kody błędów:

1401	Niepoprawny numer strony
1402	Kampania o podanych id_hash nie istnieje