Dokumentacja API: Raporty – raporty z kampanii

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:

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

W odpowiedzi serwer zwróci listę 25 kampanii.

Zwracane dane:

nameNazwa kampanii
topicTemat emaila w kampanii
subscribersIlość subskrybentów do których była wysyłka
id_hashUnikalny identyfikator kampanii
sentData 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_hashWymaganeUnikalny identyfikator kampanii, można go otrzymać wywołując metodę /rest/reports/campaignsList

Zwracane dane:

subscribersLiczba wszystkich subskrybentów do których wysłano kampanię
deliveredLiczba dostarczonych wiadomości
hard_bounceLiczba wiadomości odbitych twardo (http://www.ietf.org/rfc/rfc1893.txt)
soft_bounceLiczba wiadomości odbitych miękko (http://www.ietf.org/rfc/rfc1893.txt)
openedLiczba wszystkich otwartych wiadomości
clickedLiczba wszystkich kliknięć w danym przedziale czasowym
unique_openedLiczba unikalnych otwarć wiadomości
unique_clickedLiczba unikalnych klikniętych wiadomości
resignedLiczba wypisanych subskrybentów

Pobieranie zachowań subskrybentów w czasie

Wywołanie:

GET /rest/reports/campaignTimeDetails/[id_hash]

Dane w GET:

id_hashWymagane 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"}
 ]
 }
openedLiczba wszystkich otwarć w danym przedziale czasowym
clickedLiczba wszystkich kliknięć w danym przedziale czasowym
unique_openedLiczba unikalnych otwartych maili w danym przedziale czasowym
sunique_clickedLiczba unikalnych maili z klikniętym linkiem w danym przedziale czasowym
timeCzas w formacie „rrrr-mm-dd HH:ii”, rozdzielczość okna to 10 minut

Kody błędów:

1401Niepoprawny numer strony
1402Kampania o podanych id_hash nie istnieje