GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.
En färdig sammanställning per QR-kod finns i Rapporter.
Vad siffrorna betyder
- Skanningar. Varje antal finns i fältet
clicks. En skanning räknas varje gång någon öppnar QR-kodens korta länk. - Unika skanningar. Med
unique=trueräknas varje besökare en gång inom datumintervallet. - Omfång. Siffrorna kommer från QR-kodens korta länk. En QR-kod utan kort länk har inga skanningar att räkna.
- Historik. Statistiken kan inte nollställas via API:et. Om du tar bort en QR-kod raderas inte dess historiska skanningsdata.
Huvuden
string
obligatorisk
Bearer följt av din API-nyckel. Se Autentisering.Frågeparametrar
Båda slutpunkterna tar de här parametrarna. Alla är valfria.string
standard:"count"
Uppdelningsdimension.
count returnerar totalen. Alla värden och deras svarsform finns i Uppdelningar.string
standard:"30d"
Fördefinierat datumintervall:
24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd eller all. Se Datumintervall. Ignoreras när du skickar start.string
Start för ett anpassat intervall, ISO 8601, till exempel
2026-08-01 eller 2026-08-01T00:00:00Z. Har företräde framför interval. Måste vara tidigare än end.string
Slut för ett anpassat intervall, ISO 8601. Standard är slutet av i dag. Används tillsammans med
start eller interval=all och ignoreras med de andra intervallen.string
standard:"UTC"
IANA-tidszon som används för att justera
timeseries-intervallen, till exempel America/New_York. En okänd tidszon returnerar 422.boolean
standard:"false"
true räknar unika skanningar i stället för totalt antal skanningar.Datumintervall
För ett anpassat intervall skickar du
start och eventuellt end. Intervall på upp till 2 dagar delas upp per timme, intervall över 180 dagar per månad och allt däremellan per dag.
Dimensionsfilter
Begränsa resultaten till skanningar som matchar ett filter. Olika filter kombineras med AND. Där ett filter tar flera värden separerar du dem med kommatecken: värdena kombineras med OR.
En okänd lands- eller kontinentkod returnerar
422. Namn på enheter, webbläsare och operativsystem matchas med stor begynnelsebokstav, så mobile fungerar som Mobile.
Till exempel skanningar från USA eller Kanada på mobila enheter: ?country=US,CA&device=Mobile.
Uppdelningar
count returnerar ett objekt. Alla andra värden returnerar en array, sorterad efter clicks från högst till lägst (timeseries sorteras efter tid).
En okänd
groupBy returnerar 422 med en lista över giltiga värden.
Svar när groupBy=count:
groupBy=countries:
Hämta statistik för en QR-kod
GET /api/v1/qrs/{qrId}/analytics
Returnerar skanningsstatistik för en QR-kod, begränsad till dess korta länk. Tar frågeparametrarna och dimensionsfiltren ovan.
Hämta statistik för arbetsytan
GET /api/v1/analytics
Returnerar skanningsstatistik för alla QR-koder i din arbetsyta. Tar frågeparametrarna och dimensionsfiltren ovan, plus de här parametrarna för att begränsa omfånget.
string
Tillsammans med
key begränsas resultaten till den korta länken med den här domänen, till exempel getqr.sh. Domänen måste höra till din arbetsyta.string
Den korta länkens slug, till exempel
x7Kd2p1. Använd den tillsammans med domain. Båda finns i QR-kodobjektet.string
Kommaseparerade QR-kodstyper att ta med:
website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email eller event. Se QR-typer.Vanliga problem
400 "QR has no associated link."
400 "QR has no associated link."
QR-koden har ingen kort länk, så det finns inga skanningar att räkna.
404 vid filtrering på domain och key
404 vid filtrering på domain och key
Det finns ingen kort länk med den domänen och slugen i din arbetsyta. Kopiera
domain och key från QR-kodobjektet.422 för groupBy, interval eller ett filter
422 för groupBy, interval eller ett filter
Värdet stöds inte. Felmeddelandet anger parametern och listar de giltiga värdena.
Siffrorna stämmer inte med instrumentpanelen
Siffrorna stämmer inte med instrumentpanelen
Kontrollera att du använder samma datumintervall och tidszon, och om du räknar unika skanningar (
unique=true) eller totalt antal skanningar.