Základná URL
https://{tenant}.logzi.com/api/company_traffic/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API obratu spoločnosti vracia mesačne agregovaný obrat z predaja a fakturácie za jednotlivé spoločnosti. Užitočné v prostredí s viacerými spoločnosťami (multi-entity) na porovnanie výkonnosti na úrovni spoločnosti. Tento koncový bod je iba na čítanie.
/api/company_traffic/get
Získanie údajov o obrate spoločnosti za daný mesiac.
Parametre dotazu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
year_month | string | Formát rok-mesiac (napr. 2024-03) |
Príklad požiadavky
GET /api/company_traffic/get?year_month=2024-03
X-API-KEY: {vas_api_kluc}/api/company_traffic/list
Stránkovaný zoznam záznamov obratu spoločnosti.
Parametre dotazu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt filtračných podmienok |
Príklad požiadavky
GET /api/company_traffic/list?list_offset=0
X-API-KEY: {vas_api_kluc}Zaregistruj sa teraz,
zaplať neskôr!
