Dokumentace FoodRetailor Help

Statistiky zákazníků

Získání statistik pro zákazníky

Filtrování ziskávaných statistik

Vysvětlení jednotlivých filtru

Název parametru

Popis

dateFrom

Počáteční datum statistik (inclusive). Povinný parametr. format: "YYYY-MM-DD"

dateTo

Konečné datum statistik (inclusive). Povinný parametr. format: "YYYY-MM-DD"

granularity

Jakou chceme vrátit granularitu záznamu. Možné hodnoty:

  • Date - pro datum

  • DayOfWeek - zgroupování statistik do dne v týdnu
    hodnoty: 1 - 7

  • WeekOfMonth - zgroupování statistik do týdnů v měsíci
    hodnoty: 1 - n

  • Month - zgroupování statistik do měsícu v roce
    hodnoty: 1 - 12

  • Quarter - zgroupování statistik do kvartálu roku
    hodnoty: 1 - 4

  • WeeklyPerYear - zgroupování do týdnů pouze v daném roce (period ve výsledku obsahuje i rok)

  • MonthlyPerYear - zgroupování do měsíců pouze v daném roce (period obsahuje i rok).

customerType

Seznam typů zákazníků - např. Zákazník s mobilní aplikací, s povolenou push notifikací, apod. Nepovinný parametr

Hodnoty:

  • RegisteredActiveWithNotification

  • RegisteredActiveWithoutNotification

  • RegisteredInactive

  • Unregistered

marketId

Seznam poboček pro které chcem záznamy. Nepovinný parametr.

groupBy

Podle jakých dalších parametru se má výsledek groupovat.
Defaultní hodnota je ["customerType"].
Možné hodnoty: customerType, marketId

startOfTheWeek

Jaký je počáteční den týdne.
Defaultní hodnota je 1.
1 - Pondělí až 7 - Neděle

Návratové hodnoty

Vysvětlení návratových hodnot

Název parametru

Popis

timePeriod

Časové období pro který je daný záznam určen. Pokud ve filtru pošleme granularitu např. WeekOfMonth, tak timePeriod bude nabývat hodnot 1, 2, 3,... pokud pošleme DayOfWeek tak hodnoty budou 1 pro pondělí, 7 pro neděli, atd.

customerType

Pro jaký typ zákazníků je daný záznam.

Hodnoty:

  • RegisteredActiveWithNotification

  • RegisteredActiveWithoutNotification

  • RegisteredInactive

  • Unregistered

marketId

Id pobočky pro kterou je záznam určen.

totalPrice

Celková hodnota produktů, které zákazníci nakoupili.

soldUnits

Celkový počet prodaných kusů.

baskets

Celkový počet prodaných košíků.

customersCount

Počet unikátních zákazníků pro daný záznam.

productsCount

Počet unikátních produktů pro daný záznam.

API specifikace

/statistics/customer

Collect and return customer statistics for the specified filters.

Request parameters

{ "dateFrom": "2025-04-28", "dateTo": "2025-05-28", "customerType": [], "marketId": [], "granularity": "WeekOfMonth", "groupBy": [ "customerType" ], "startOfTheWeek": "WEDNESDAY" }

Responses

[ { "timePeriod": "1", "marketId": "4005", "customerType": "RegisteredActiveWithNotification", "totalPrice": 1242.9, "soldUnits": 12.0, "baskets": 12, "customersCount": 132321, "productsCount": 1234 } ]
28 May 2025