API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.
Pentru un rezumat gata făcut pentru fiecare cod QR, consultați Rapoarte.
Ce înseamnă cifrele
- Scanări. Fiecare număr se află în câmpul
clicks. O scanare este numărată de fiecare dată când cineva deschide linkul scurt al codului QR. - Scanări unice. Cu
unique=true, fiecare vizitator este numărat o singură dată în intervalul de date. - Domeniu. Cifrele provin din linkul scurt al codului QR. Un cod QR fără link scurt nu are scanări de numărat.
- Istoric. Statisticile nu pot fi resetate prin API. Ștergerea unui cod QR nu elimină datele istorice ale scanărilor sale.
Anteturi
string
obligatoriu
Bearer urmat de cheia dvs. API. Consultați Autentificare.Parametri de interogare
Ambele endpointuri primesc acești parametri. Toți sunt opționali.string
implicit:"count"
Dimensiunea defalcării.
count returnează totalul. Consultați Defalcări pentru toate valorile și forma răspunsului fiecăreia.string
implicit:"30d"
Interval de date prestabilit:
24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd sau all. Consultați Intervale de date. Ignorat când trimiteți start.string
Începutul unui interval personalizat, ISO 8601, de exemplu
2026-08-01 sau 2026-08-01T00:00:00Z. Are prioritate față de interval. Trebuie să fie anterior lui end.string
Sfârșitul unui interval personalizat, ISO 8601. Implicit, sfârșitul zilei de azi. Se folosește împreună cu
start sau cu interval=all și este ignorat cu celelalte intervale.string
implicit:"UTC"
Fusul orar IANA folosit pentru alinierea intervalelor
timeseries, de exemplu America/New_York. Un fus orar necunoscut returnează 422.boolean
implicit:"false"
true numără scanările unice în locul totalului scanărilor.Intervale de date
Pentru un interval personalizat, trimiteți
start și, opțional, end. Intervalele de până la 2 zile folosesc grupări pe ore, cele de peste 180 de zile folosesc grupări pe luni, iar toate celelalte folosesc grupări pe zile.
Filtre pe dimensiuni
Restrângeți rezultatele la scanările care corespund unui filtru. Filtrele diferite se combină cu AND. Când un filtru primește mai multe valori, separați-le prin virgule: valorile se combină cu OR.
Un cod de țară sau de continent necunoscut returnează
422. Numele dispozitivelor, browserelor și sistemelor de operare sunt comparate cu prima literă mare, așa că mobile funcționează la fel ca Mobile.
De exemplu, scanările din SUA sau Canada de pe dispozitive mobile: ?country=US,CA&device=Mobile.
Defalcări
count returnează un obiect. Toate celelalte valori returnează un array, sortat după clicks descrescător (timeseries este sortat cronologic).
Un
groupBy necunoscut returnează 422 cu lista valorilor valide.
Răspuns când groupBy=count:
groupBy=countries:
Statistici pentru un cod QR
GET /api/v1/qrs/{qrId}/analytics
Returnează statisticile de scanare pentru un cod QR, limitate la linkul său scurt. Primește parametrii de interogare și filtrele pe dimensiuni de mai sus.
Statistici pentru spațiul de lucru
GET /api/v1/analytics
Returnează statisticile de scanare pentru toate codurile QR din spațiul dvs. de lucru. Primește parametrii de interogare și filtrele pe dimensiuni de mai sus, plus acești parametri de delimitare.
string
Împreună cu
key, limitează rezultatele la linkul scurt cu acest domeniu, de exemplu getqr.sh. Domeniul trebuie să aparțină spațiului dvs. de lucru.string
Slugul linkului scurt, de exemplu
x7Kd2p1. Folosiți-l împreună cu domain. Ambele se află în obiectul cod QR.string
Tipurile de coduri QR incluse, separate prin virgulă:
website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email sau event. Consultați Tipuri de coduri QR.Probleme frecvente
400 "QR has no associated link."
400 "QR has no associated link."
Codul QR nu are link scurt, așa că nu există scanări de numărat.
404 la filtrarea după domain și key
404 la filtrarea după domain și key
În spațiul dvs. de lucru nu există niciun link scurt cu acel domeniu și slug. Copiați
domain și key din obiectul cod QR.422 pentru groupBy, interval sau un filtru
422 pentru groupBy, interval sau un filtru
Valoarea nu este acceptată. Mesajul de eroare indică parametrul și enumeră valorile valide.
Cifrele nu corespund cu cele din panou
Cifrele nu corespund cu cele din panou
Verificați dacă folosiți același interval de date și același fus orar și dacă numărați scanările unice (
unique=true) sau totalul scanărilor.