Dokumentace FoodRetailor Help

Statistiky doporučování

Získání statistik pro doporučování

Filtrování ziskávaných statistik

Vysvětlení jednotlivých filtru

Název parametru

Popis

dateFrom

Počáteční datum statistik (inclusive). Povinný parametr.

dateTo

Konečné datum statistik (inclusive). Povinný parametr.

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).

source

Seznam zdrojů statistik (např. mobilní aplikace - Android, mobilní aplikace - iOS, Web, Eamailing,..). Pokud není vyplněno budou vraceny statistiky pro všechny zdroje.

origin

Seznam míst ve kterých je doporučování umístěno v rámci daného source. Např. source mobilní aplikace - android může mít různé origin např. Moje Produkty, Vybráno pro Vás, Detail novinky, atd. Pokud není vyplněno vrací se statistiky pro všechy origin.

originId

Místo v aplikaci může být mít identifkátor. Např. Novinek v aplikaci je více a pokud bychom chtěli filtrovat statistiky pouze pro danou novinku můžeme využit kombinaci origin - News a originId - 14, kde 14 je id novinky pro kterou chceme statistiky filtrovat. Pokud není vyplněno vrací se pro všechny originId včetně těch, které mají nulovou hodnotu.

strategy

Chceme-li sledovat výkonnost daných strategií, vyplníme seznam názvu strategií, pro které chceme získat statistiky. Nepovinná hodnota, pokud není vyplěno vrací se statistiky pro všechny strategie.

priceType

Chceme-li filtrovat statistiky pouze pro daný typ ceny, za který byl produkt prodaný. Např. chceme vratit statistiky pouze pro zboží, které bylo zakoupeno bez slevy. Nepovinná hodnota, pokud není vyplněno vrací se statistiky pro všechny cenové typy.

groupBy

Podle jakých dalších parametru se má výsledek groupovat.
Defaultní hodnota je ["origin", "originId"].
Možné hodnoty: source, origin, originId, strategy, priceType, 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.

source

Stejně jako u filtru určuje z jakého zdroje záznam pochází.

origin

Stejně jako u filtru.

originId

Stejně jako u filtru.

strategy

Stejně jako u filtru.

priceType

Stejně jako u filtru.

marketId

Stejně jako u filtru.

totalPrice

Celkový obrat

totalSoldUnits

Počet prodaných jednotek.

API specifikace

/statistics/recommendation

Collect and return recommendation statistics for the specified filters.

Request parameters

{ "dateFrom": "2025-04-27", "dateTo": "2025-05-27", "source": [], "origin": [], "originId": [], "strategy": [], "priceType": [], "granularity": "WeekOfMonth", "groupBy": [ "originId", "strategy", "origin" ], "startOfTheWeek": "WEDNESDAY" }

Responses

[ { "timePeriod": "1", "source": "Mobile App - Android", "origin": "News", "originId": "12", "strategy": "default", "priceType": "Discounted", "marketId": "1", "totalCustomers": 150, "totalPrice": 5221.21, "totalSoldUnits": 512.0, "totalProducts": 351 } ]
28 May 2025