GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
Headere
string
påkrevd
Bearer etterfulgt av API-nøkkelen din. Se Autentisering.string
application/json. Påkrevd ved POST- og PATCH-forespørsler.Omfang
Både enkeltstående og planlagte rapporter tar etscope:
En rapport viser maksimalt 50 QR-koder. Med
all er det de sist opprettede aktive QR-kodene; koder som er satt på pause, utelates. Med selected og single tas koder som er satt på pause, med. QR-koder uten kortlenke har ingen skanninger og hoppes over.
Periode
Perioden er alltid den siste avsluttede, så en rapport inneholder aldri delvise data fra i dag. Grensene er midnatt i rapportens tidssone.Eksporter en rapport
POST /api/v1/reports
Bygger en rapport for den siste avsluttede perioden og returnerer den i svaret.
string
påkrevd
json returnerer rapporten i svarets body. csv og pdf returnerer en fil som lastes ned.string[]
QR-kodene rapporten skal dekke. Påkrevd for
selected (én eller flere ID-er) og single (nøyaktig én ID). Utelat den for all.string
standard:"UTC"
IANA-tidssone som periodegrensene justeres etter, for eksempel
America/New_York. En ukjent tidssone returnerer 422.string
standard:"en"
Språket i PDF-en, for eksempel
en eller de. En verdi som ikke støttes, faller tilbake til engelsk. Ignoreres av csv og json.string
Tittel som vises på PDF-en, opptil 40 tegn. Ignoreres av
csv og json.JSON-svar
string
Første dag i perioden,
YYYY-MM-DD.string
Første dag etter perioden,
YYYY-MM-DD. Perioden slutter ved midnatt i starten av denne dagen.object[]
Én oppføring per QR-kode.
CSV- og PDF-svar
Body er filen.Content-Disposition gir den navn etter perioden, for eksempel report-2026-08-10_2026-08-17.csv. CSV-filen har én rad per QR-kode med kolonnene QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS og Top browser.
Objektet for planlagt rapport
En planlagt rapport sendes på e-post til kontoen som opprettet den, ved midnatt i rapportens tidssone.string
ID-en til den planlagte rapporten.
string | null
Etikett som vises i emnet på e-posten og i dashbordet.
string
daily, weekly eller monthly.string
all, selected eller single.string[] | null
QR-kodene rapporten dekker med omfangene
selected og single. null når ingen ID-er ble sendt.null
Alltid
null. Reservert.boolean
Om en PDF legges ved e-posten.
string
active eller paused.string
IANA-tidssone som sendetidspunktet og perioden justeres etter.
string
Språket i e-posten og PDF-en.
string
Når neste e-post skal sendes, ISO 8601: neste midnatt (
daily), neste mandag (weekly) eller den 1. i neste måned (monthly), i rapportens tidssone.string | null
Når siste e-post ble sendt, ISO 8601.
string
Opprettelsesdato, ISO 8601.
string
Dato for siste oppdatering, ISO 8601.
Vis planlagte rapporter
GET /api/v1/reports/schedules
Returnerer de planlagte rapportene i arbeidsområdet ditt, også de som andre medlemmer har opprettet, med de nyeste først. Listen er paginert: se Paginering.
integer
standard:"1"
Siden som skal returneres, 1 eller høyere.
integer
standard:"100"
Resultater per side, 1 til 100.
Planlegg en rapport
POST /api/v1/reports/schedules
Oppretter en rapport som sendes på e-post med jevne mellomrom. nextRunAt beregnes ut fra frekvensen og tidssonen.
En QR-kode kan bare tilhøre én planlagt rapport per frekvens. En overlappende tidsplan returnerer
409 conflict.all overlapper alle andre rapporter med samme frekvens. Rapporter som er satt på pause, teller også.
string
påkrevd
Hvor ofte rapporten sendes:
daily, weekly eller monthly. Bestemmer også perioden den dekker. Se Periode.string
påkrevd
IANA-tidssone som sendetidspunktet og perioden justeres etter, for eksempel
America/New_York. En ukjent tidssone returnerer 422.string
påkrevd
Språket i e-posten og PDF-en, for eksempel
en eller de. En verdi som ikke støttes, faller tilbake til engelsk. PDF-er på zh, ja, ko og ar gjengis på engelsk.string[]
QR-kodene rapporten skal dekke. Påkrevd for
selected (én eller flere ID-er) og single (nøyaktig én ID). Hver ID må være en QR-kode i arbeidsområdet ditt, ellers returnerer forespørselen 404.string
Etikett som vises i emnet på e-posten og i dashbordet, opptil 40 tegn.
boolean
standard:"false"
Legg ved en PDF-versjon av rapporten i e-posten.
Oppdater en planlagt rapport
PATCH /api/v1/reports/schedules/{id}
Endrer en planlagt rapport, eller setter den på pause og gjenopptar den. Send bare feltene du vil endre, minst ett. Endrer du frekvensen eller tidssonen, eller gjenopptar en rapport som er satt på pause, beregnes nextRunAt på nytt. Regelen om én rapport per frekvens gjelder fortsatt, så en overlappende endring returnerer 409.
string
påkrevd
ID-en til den planlagte rapporten. Hent den fra svaret på listen eller opprettelsen.
string
paused stopper e-postene uten å slette tidsplanen. active gjenopptar dem.string
Etikett, opptil 40 tegn.
string
daily, weekly eller monthly.string
all, selected eller single.string[]
QR-kodene rapporten skal dekke. Hver ID må være en QR-kode i arbeidsområdet ditt.
boolean
Legg ved en PDF i e-posten.
string
IANA-tidssone.
string
Språket i e-posten og PDF-en.
Slett en planlagt rapport
DELETE /api/v1/reports/schedules/{id}
Sletter tidsplanen og stopper alle videre e-poster.
string
påkrevd
ID-en til den planlagte rapporten.
Vanlige problemer
404 når jeg eksporterer en rapport
404 når jeg eksporterer en rapport
Med omfanget
selected eller single samsvarte ingen av qrIds med en QR-kode med kortlenke i arbeidsområdet ditt. Sjekk ID-ene.404 "QR not found." når jeg planlegger en rapport
404 "QR not found." når jeg planlegger en rapport
En av
qrIds er ikke en QR-kode i arbeidsområdet ditt, eller den er slettet. Sjekk ID-ene med Vis QR-koder.409 når jeg planlegger en rapport
409 når jeg planlegger en rapport
En av QR-kodene tilhører allerede en planlagt rapport med samme frekvens, eller en rapport med den frekvensen bruker omfanget
all. Rediger eller slett den rapporten, eller velg en annen frekvens.404 "Scheduled report not found."
404 "Scheduled report not found."
id samsvarer ikke med en planlagt rapport i arbeidsområdet ditt. Hent den fra Vis planlagte rapporter.Rapporten mangler dagens skanninger
Rapporten mangler dagens skanninger
Rapporter dekker bare den siste avsluttede perioden. Bruk Analyse for tall i sanntid.