GetQR API je v beta verzi a je dostupné pro vybrané pracovní prostory. Do obecného vydání se podrobnosti mohou změnit.
Hotové souhrny pro jednotlivé QR kódy najdete v části Reporty.
Co čísla znamenají
- Skenování. Každý počet je v poli
clicks. Skenování se započítá pokaždé, když někdo otevře krátký odkaz QR kódu. - Unikátní skenování. S
unique=truese každý návštěvník v daném období započítá jen jednou. - Rozsah. Čísla pocházejí z krátkého odkazu QR kódu. QR kód bez krátkého odkazu nemá žádná skenování k započítání.
- Historie. Analytiku nelze přes API resetovat. Smazání QR kódu historická data skenování neodstraní.
Hlavičky
Parametry dotazu
Oba endpointy přijímají tyto parametry. Všechny jsou nepovinné.string
výchozí:"count"
Dimenze rozpadu.
count vrátí celkový počet. Všechny hodnoty a tvar jejich odpovědí najdete v části Rozpady.string
výchozí:"30d"
Přednastavené období:
24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd nebo all. Viz Období. Ignoruje se, když pošlete start.string
Začátek vlastního období, ISO 8601, například
2026-08-01 nebo 2026-08-01T00:00:00Z. Má přednost před interval. Musí být dříve než end.string
Konec vlastního období, ISO 8601. Výchozí hodnota je konec dnešního dne. Používá se spolu se
start nebo s interval=all a s ostatními intervaly se ignoruje.string
výchozí:"UTC"
Časové pásmo IANA pro zarovnání intervalů
timeseries, například America/New_York. Neznámé časové pásmo vrátí 422.boolean
výchozí:"false"
true počítá unikátní skenování místo celkového počtu skenování.Období
Pro vlastní období pošlete
start a volitelně end. Období do 2 dnů používají hodinové intervaly, období delší než 180 dní měsíční a vše mezi tím denní.
Filtry dimenzí
Zužte výsledky na skenování, která odpovídají filtru. Různé filtry se kombinují přes AND. Pokud filtr přijímá více hodnot, oddělte je čárkami: hodnoty se kombinují přes OR.
Neznámý kód země nebo kontinentu vrátí
422. Názvy zařízení, prohlížečů a operačních systémů se porovnávají s velkým počátečním písmenem, takže mobile funguje stejně jako Mobile.
Například skenování z USA nebo Kanady na mobilních zařízeních: ?country=US,CA&device=Mobile.
Rozpady
count vrací objekt. Všechny ostatní hodnoty vracejí pole seřazené podle clicks od nejvyšší po nejnižší (timeseries je seřazené podle času).
Neznámá hodnota
groupBy vrátí 422 se seznamem platných hodnot.
Odpověď při groupBy=count:
groupBy=countries:
Získání analytiky QR kódu
GET /api/v1/qrs/{qrId}/analytics
Vrací statistiky skenování pro jeden QR kód, omezené na jeho krátký odkaz. Přijímá výše uvedené parametry dotazu a filtry dimenzí.
Získání analytiky pracovního prostoru
GET /api/v1/analytics
Vrací statistiky skenování napříč všemi QR kódy ve vašem pracovním prostoru. Přijímá výše uvedené parametry dotazu a filtry dimenzí a navíc tyto parametry pro zúžení rozsahu.
string
Spolu s
key omezí výsledky na krátký odkaz s touto doménou, například getqr.sh. Doména musí patřit k vašemu pracovnímu prostoru.string
Slug krátkého odkazu, například
x7Kd2p1. Používejte ho spolu s domain. Obojí najdete v objektu QR kódu.string
Typy QR kódů oddělené čárkami, které se mají zahrnout:
website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email nebo event. Viz Typy QR kódů.Časté problémy
400 "QR has no associated link."
400 "QR has no associated link."
QR kód nemá krátký odkaz, takže nejsou žádná skenování k započítání.
404 při filtrování podle domain a key
404 při filtrování podle domain a key
Ve vašem pracovním prostoru neexistuje krátký odkaz s touto doménou a slugem. Zkopírujte
domain a key z objektu QR kódu.422 u groupBy, interval nebo filtru
422 u groupBy, interval nebo filtru
Hodnota není podporovaná. Chybová zpráva uvádí parametr a vypisuje platné hodnoty.
Čísla neodpovídají dashboardu
Čísla neodpovídají dashboardu
Ověřte, že používáte stejné období a časové pásmo a zda počítáte unikátní skenování (
unique=true), nebo celkový počet skenování.