A GetQR API béta állapotban van, és csak kiválasztott munkaterületek számára érhető el. A részletek az általános kiadásig változhatnak.
Fejlécek
string
kötelező
Bearer, majd az API-kulcsa. Lásd: Hitelesítés.string
application/json. A POST és a PATCH kéréseknél kötelező.Hatókör
Az egyszeri és az ütemezett jelentések egyaránt egyscope értéket várnak:
Egy jelentés legfeljebb 50 QR-kódot sorol fel. Az
all esetén ezek a legutóbb létrehozott aktív QR-kódok; a szüneteltetett kódok kimaradnak. A selected és a single esetén a szüneteltetett kódok is szerepelnek. A rövid link nélküli QR-kódoknak nincs beolvasásuk, ezért kimaradnak.
Időszak
Az időszak mindig a legutóbbi lezárult időszak, így a jelentés soha nem tartalmazza a mai nap részleges adatait. Határai a jelentés időzónája szerinti éjfélek.Jelentés exportálása
POST /api/v1/reports
Elkészíti a jelentést a legutóbbi lezárult időszakra, és a válaszban adja vissza.
string
kötelező
A
json a válasz törzsében adja vissza a jelentést. A csv és a pdf letölthető fájlt ad vissza.string[]
A lefedendő QR-kódok. Kötelező a
selected (egy vagy több azonosító) és a single (pontosan egy azonosító) esetén. Az all esetén hagyja el.string
alapértelmezett:"UTC"
IANA időzóna, amelyhez az időszak határai igazodnak, például
America/New_York. Ismeretlen időzóna esetén 422 a válasz.string
alapértelmezett:"en"
A PDF nyelve, például
en vagy de. Nem támogatott érték esetén angol lesz. A csv és a json figyelmen kívül hagyja.string
A PDF-en megjelenő cím, legfeljebb 40 karakter. A
csv és a json figyelmen kívül hagyja.JSON-válasz
string
Az időszak első napja,
YYYY-MM-DD.string
Az időszak utáni első nap,
YYYY-MM-DD. Az időszak ennek a napnak a kezdetén, éjfélkor ér véget.object[]
QR-kódonként egy bejegyzés.
CSV- és PDF-válasz
A törzs maga a fájl. AContent-Disposition az időszakról nevezi el, például report-2026-08-10_2026-08-17.csv. A CSV QR-kódonként egy sort tartalmaz, a következő oszlopokkal: QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS és Top browser.
Az ütemezett jelentés objektum
Az ütemezett jelentést a rendszer annak a fióknak küldi el e-mailben, amely létrehozta, a jelentés időzónája szerinti éjfélkor.string
Az ütemezett jelentés azonosítója.
string | null
Címke, amely az e-mail tárgyában és az irányítópulton jelenik meg.
string
daily, weekly vagy monthly.string
all, selected vagy single.string[] | null
A jelentés által lefedett QR-kódok a
selected és a single hatókörnél. null, ha nem küldtek azonosítókat.null
Mindig
null. Későbbi használatra fenntartva.boolean
Csatol-e a rendszer PDF-et az e-mailhez.
string
active vagy paused.string
IANA időzóna, amelyhez a küldés időpontja és az időszak igazodik.
string
Az e-mail és a PDF nyelve.
string
A következő e-mail esedékessége, ISO 8601: a következő éjfél (
daily), a következő hétfő (weekly) vagy a következő hónap 1. napja (monthly), a jelentés időzónája szerint.string | null
A legutóbbi e-mail elküldésének időpontja, ISO 8601.
string
Létrehozás dátuma, ISO 8601.
string
Utolsó frissítés dátuma, ISO 8601.
Ütemezett jelentések listázása
GET /api/v1/reports/schedules
A munkaterület ütemezett jelentéseit adja vissza – a más tagok által létrehozottakat is –, a legújabbal kezdve. A lista lapozható: lásd Lapozás.
integer
alapértelmezett:"1"
A visszaadandó oldal, 1 vagy nagyobb.
integer
alapértelmezett:"100"
Találatok oldalanként, 1 és 100 között.
Jelentés ütemezése
POST /api/v1/reports/schedules
Létrehoz egy jelentést, amelyet a rendszer rendszeresen elküld e-mailben. A nextRunAt értékét a gyakoriság és az időzóna alapján számítja ki.
Egy QR-kód gyakoriságonként csak egy ütemezett jelentéshez tartozhat. Átfedő ütemezés esetén
409 conflict a válasz.all hatókörű jelentés minden más, azonos gyakoriságú jelentéssel átfed. A szüneteltetett jelentések is számítanak.
string
kötelező
Milyen gyakran küldi a rendszer a jelentést:
daily, weekly vagy monthly. Ez határozza meg a lefedett időszakot is. Lásd: Időszak.string
kötelező
IANA időzóna, amelyhez a küldés időpontja és az időszak igazodik, például
America/New_York. Ismeretlen időzóna esetén 422 a válasz.string
kötelező
Az e-mail és a PDF nyelve, például
en vagy de. Nem támogatott érték esetén angol lesz. A zh, ja, ko és ar nyelvű PDF-ek angolul készülnek.string[]
A lefedendő QR-kódok. Kötelező a
selected (egy vagy több azonosító) és a single (pontosan egy azonosító) esetén. Minden azonosítónak a munkaterület egy QR-kódjához kell tartoznia, különben a kérés 404 választ ad.string
Címke, amely az e-mail tárgyában és az irányítópulton jelenik meg, legfeljebb 40 karakter.
boolean
alapértelmezett:"false"
A jelentés PDF-változatának csatolása az e-mailhez.
Ütemezett jelentés frissítése
PATCH /api/v1/reports/schedules/{id}
Módosít egy ütemezett jelentést, vagy szünetelteti és folytatja. Csak a módosítani kívánt mezőket küldje el, de legalább egyet. A gyakoriság vagy az időzóna módosítása, illetve egy szüneteltetett jelentés folytatása újraszámolja a nextRunAt értékét. A gyakoriságonként egy jelentés szabály továbbra is érvényes, így egy átfedést okozó módosítás 409 választ ad.
string
kötelező
Az ütemezett jelentés azonosítója. A lista vagy a létrehozás válaszából veheti.
string
A
paused leállítja az e-maileket az ütemezés törlése nélkül. Az active folytatja őket.string
Címke, legfeljebb 40 karakter.
string
daily, weekly vagy monthly.string
all, selected vagy single.string[]
A lefedendő QR-kódok. Minden azonosítónak a munkaterület egy QR-kódjához kell tartoznia.
boolean
PDF csatolása az e-mailhez.
string
IANA időzóna.
string
Az e-mail és a PDF nyelve.
Ütemezett jelentés törlése
DELETE /api/v1/reports/schedules/{id}
Törli az ütemezést, és leállítja az összes további e-mailt.
string
kötelező
Az ütemezett jelentés azonosítója.
Gyakori problémák
404-es hiba jelentés exportálásakor
404-es hiba jelentés exportálásakor
A
selected vagy a single hatókörnél a qrIds egyike sem egyezett a munkaterület egy rövid linkkel rendelkező QR-kódjával. Ellenőrizze az azonosítókat.404 „QR not found.” jelentés ütemezésekor
404 „QR not found.” jelentés ütemezésekor
A
qrIds valamelyike nem a munkaterület QR-kódja, vagy törölték. Ellenőrizze az azonosítókat a QR-kódok listázása végponttal.409-es hiba jelentés ütemezésekor
409-es hiba jelentés ütemezésekor
Az egyik QR-kód már egy azonos gyakoriságú ütemezett jelentéshez tartozik, vagy egy ilyen gyakoriságú jelentés
all hatókört használ. Szerkessze vagy törölje azt a jelentést, vagy válasszon más gyakoriságot.404 "Scheduled report not found."
404 "Scheduled report not found."
Az
id nem egyezik a munkaterület egyik ütemezett jelentésével sem. Vegye az Ütemezett jelentések listázása válaszából.A jelentésből hiányoznak a mai beolvasások
A jelentésből hiányoznak a mai beolvasások
A jelentések csak a legutóbbi lezárult időszakot fedik le. Élő számokhoz használja az Analitika végpontot.