API

Získat seznam push notifikací

GET/api/crm/v2/push_notificationsv2
operationId: pushNotifications.default

Autorizace

api-token + language + role

Parametry dotazu

date_creation_fromstring

Příklad: 25/04/2024

date_creation_tostring

Příklad: 26/04/2024

chain_idinteger

Příklad: 7124

branch_idinteger
page_numberinteger

Příklad: 1

Odpovědi

OK

object
statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmůže být null

Příklad: 2026-08-01 00:00:00

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_toobject (FilterDateTo)
valuestringmůže být null

Příklad: 2026-08-31 23:59:59

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_rangeobject (FilterDateRange)

Přednastavená období filtru podle data; dolní hranice je vypočítána v časovém pásmu uživatele. value — období, kterému odpovídají aktuální *_from a *_to; null — vlastní období. default — období, které server nastaví v požadavku bez dat: použije se také při prvním načtení sekce a při resetování. Horní hranice období je vždy rovna aktuálnímu dni uživatele, proto ji option neobsahuje: pro přednastavené období není třeba předávat *_to, server ji nastaví sám. Období delší než jeden rok je zkráceno na straně novější hranice.

valuestring (DateRange) může být null

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

defaultstring (DateRange) povinné

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

typestringpovinné

Příklad: select

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

optionarray of objectpovinné
valuestring (DateRange) povinné

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

date_fromstringpovinné

Příklad: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

firms_prices_pushnumber

Příklad: 0.06

holiday_datesarray of string
listarray of object
idintegerpovinné

Příklad: 1

statusstring (StatusPushNotifications) povinné

Hodnoty:in_queuerunsuccesserrorend_with_error

Příklad: in_queue

branch_idintegerpovinné

Příklad: 1

titlestring

Příklad: title

ios_successintegerpovinné

Příklad: 0

ios_failureintegerpovinné

Příklad: 0

android_successintegerpovinné

Příklad: 0

android_failureintegerpovinné

Příklad: 0

site_successintegerpovinné

Příklad: 0

site_failureintegerpovinné

Příklad: 0

price_onenumberpovinné

Příklad: 0

messagestringpovinné

Příklad: Lorem Ipsum is simply dummy text of the printing and typesetting industry

platformstring (Platform) povinné

Hodnoty:androidiosallmobile_appssitesocial_apps

Příklad: all

genderstring (Gender)

Hodnoty:womanman

Příklad: man

date_of_birth_fromstring

Příklad: 09/07

date_of_birth_tostring

Příklad: 10/07

date_creationstring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

date_sendingstring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

date_last_order_fromstring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

date_last_order_tostring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

namestringpovinné

Název sítě

Příklad: Green Basket

city_namestringpovinné

Příklad: Voronezh

sumnumber

Cena push notifikace

Příklad: 0

paginationobject (Pagination)
max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: false