Eksport listy odbiorców i aktywności odbiorców
Asynchroniczne API daje możliwość pobrania listy odbiorców. Jako, że jest to API asynchroniczne nie ma pełnej walidacji wprowadzanych zmiennych na starcie. Pełne sprawdzanie parametrów „state” oraz „custom_fields” następuje w procesie głównym. Jeżeli te pola będą miały niepoprawną wartość zostaną zastąpione wartością domyślną. Jeśli niepoprawne będą tylko poszczególne elementy tych parametrów zostaną one pominięte.
Wywołanie:
/rest/async_subscribers_list/export
Dane
list | Wymagane | Hash listy odbiorców |
---|---|---|
state | Opcjonalne | Tablica z statusami odbiorców(lista statusów w „Subskrybenci” klasycznego API). Domyślnie wszyscy odbiorcy przykład: [1,2,4] |
custom_fields | Opcjonalne | Lista pól dodatkowych jakie mają być dołączone do eksportu. Na liście należy umieścić „personalization_tag” interesującego nas pola. Domyślnie żadne pole nie jest wybrane. Przykład: ['pole1','pole2'] |
Zwracane dane
id_job | Id procesu po którym będzie można sprawdzić jego status oraz pobrać końcowy wynik |
---|
Kody błędów:
2010 | Nie znaleziono listy odbiorców |
---|
Eksport akcji odbiorców
API daje możliwość pobrania wszystkich akcji jakie wykonali odbiorcy danego dnia.
Tak jak w przypadku eksportu listy na starcie nie ma pełnej walidacji danych, tutaj na starcie walidowana jest tylko poprawność formatu daty.
Wywołanie:
/rest/async_subscribers_actions/export
Dane
date | Wymagane | Data w formacie „YYYY-MM-DD” |
---|---|---|
type | Opcjonalne | Dostępne typy: all, opened, clicked, bounced, unsubscribed. Domyślna wartość: all |
Zwracane dane
id_job | Id procesu po którym będzie można sprawdzić jego status oraz pobrać końcowy wynik |
---|
Kody błędów
2020 | Niepoprawny format daty |
---|