GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.
Headere
string
påkrævet
Bearer efterfulgt af din API-nøgle. Se Godkendelse.string
application/json. Påkrævet ved POST- og PATCH-forespørgsler.Omfang
Både enkeltstående og planlagte rapporter tager etscope:
En rapport viser højst 50 QR-koder. Med
all er det de senest oprettede aktive QR-koder; koder på pause udelades. Med selected og single medtages koder på pause. QR-koder uden kortlink har ingen scanninger og springes over.
Periode
Perioden er altid den seneste afsluttede, så en rapport aldrig medtager dagens ufuldstændige data. Dens grænser ligger ved midnat i rapportens tidszone.Eksportér en rapport
POST /api/v1/reports
Bygger en rapport for den seneste afsluttede periode og returnerer den i svaret.
string
påkrævet
json returnerer rapporten i svarets body. csv og pdf returnerer en fil til download.string[]
QR-koder, der skal dækkes. Påkrævet for
selected (et eller flere id’er) og single (præcis ét id). Udelad det for all.string
standard:"UTC"
IANA-tidszone, som periodens grænser justeres efter, f.eks.
America/New_York. En ukendt tidszone returnerer 422.string
standard:"en"
PDF’ens sprog, f.eks.
en eller de. En værdi, der ikke understøttes, falder tilbage til engelsk. Ignoreres af csv og json.string
Titel, der vises på PDF’en, op til 40 tegn. Ignoreres af
csv og json.JSON-svar
string
Periodens første dag,
YYYY-MM-DD.string
Den første dag efter perioden,
YYYY-MM-DD. Perioden slutter ved midnat i starten af denne dag.object[]
Én post pr. QR-kode.
CSV- og PDF-svar
Body er filen.Content-Disposition navngiver den efter perioden, f.eks. report-2026-08-10_2026-08-17.csv. CSV-filen har én række pr. QR-kode med kolonnerne QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS og Top browser.
Objektet for en planlagt rapport
En planlagt rapport sendes med e-mail til den konto, der oprettede den, ved midnat i dens tidszone.string
Den planlagte rapports id.
string | null
Etiket, der vises i e-mailens emnelinje og i dashboardet.
string
daily, weekly eller monthly.string
all, selected eller single.string[] | null
QR-koder, som rapporten dækker med omfangene
selected og single. null, når der ikke er sendt nogen id’er.null
Altid
null. Reserveret.boolean
Om en PDF vedhæftes e-mailen.
string
active eller paused.string
IANA-tidszone, som afsendelsestidspunktet og perioden justeres efter.
string
Sproget for e-mailen og PDF’en.
string
Hvornår næste e-mail skal sendes, ISO 8601: næste midnat (
daily), næste mandag (weekly) eller den 1. i næste måned (monthly) i rapportens tidszone.string | null
Hvornår den seneste e-mail blev sendt, ISO 8601.
string
Oprettelsesdato, ISO 8601.
string
Dato for seneste opdatering, ISO 8601.
Vis planlagte rapporter
GET /api/v1/reports/schedules
Returnerer de planlagte rapporter i dit arbejdsområde, også dem, som andre medlemmer har oprettet, med de nyeste først. Listen er pagineret: se Paginering.
integer
standard:"1"
Siden, der returneres, 1 eller højere.
integer
standard:"100"
Resultater pr. side, 1 til 100.
Planlæg en rapport
POST /api/v1/reports/schedules
Opretter en rapport, der sendes med e-mail med faste mellemrum. nextRunAt beregnes ud fra frekvensen og tidszonen.
En QR-kode kan kun indgå i én planlagt rapport pr. frekvens. En overlappende plan returnerer
409 conflict.all overlapper alle andre rapporter med samme frekvens. Rapporter på pause tæller også med.
string
påkrævet
Hvor ofte rapporten sendes:
daily, weekly eller monthly. Bestemmer også den periode, den dækker. Se Periode.string
påkrævet
IANA-tidszone, som afsendelsestidspunktet og perioden justeres efter, f.eks.
America/New_York. En ukendt tidszone returnerer 422.string
påkrævet
Sproget for e-mailen og PDF’en, f.eks.
en eller de. En værdi, der ikke understøttes, falder tilbage til engelsk. PDF’er på zh, ja, ko og ar vises på engelsk.string[]
QR-koder, der skal dækkes. Påkrævet for
selected (et eller flere id’er) og single (præcis ét id). Hvert id skal være en QR-kode i dit arbejdsområde, ellers returnerer forespørgslen 404.string
Etiket, der vises i e-mailens emnelinje og i dashboardet, op til 40 tegn.
boolean
standard:"false"
Vedhæft en PDF-udgave af rapporten i e-mailen.
Opdater en planlagt rapport
PATCH /api/v1/reports/schedules/{id}
Ændrer en planlagt rapport eller sætter den på pause og genoptager den. Send kun de felter, du vil ændre, mindst ét. Ændrer du frekvensen eller tidszonen, eller genoptager du en rapport på pause, beregnes nextRunAt igen. Reglen om én rapport pr. frekvens gælder stadig, så en overlappende ændring returnerer 409.
string
påkrævet
Den planlagte rapports id. Hent det fra svaret på listen eller oprettelsen.
string
paused stopper e-mailene uden at slette planen. active genoptager dem.string
Etiket, op til 40 tegn.
string
daily, weekly eller monthly.string
all, selected eller single.string[]
QR-koder, der skal dækkes. Hvert id skal være en QR-kode i dit arbejdsområde.
boolean
Vedhæft en PDF i e-mailen.
string
IANA-tidszone.
string
Sproget for e-mailen og PDF’en.
Slet en planlagt rapport
DELETE /api/v1/reports/schedules/{id}
Sletter planen og stopper alle fremtidige e-mails.
string
påkrævet
Den planlagte rapports id.
Almindelige problemer
404 ved eksport af en rapport
404 ved eksport af en rapport
Med omfanget
selected eller single matchede ingen af qrIds en QR-kode med kortlink i dit arbejdsområde. Tjek id’erne.404 "QR not found." ved planlægning af en rapport
404 "QR not found." ved planlægning af en rapport
Et af
qrIds er ikke en QR-kode i dit arbejdsområde, eller den er slettet. Tjek id’erne med Vis QR-koder.409 ved planlægning af en rapport
409 ved planlægning af en rapport
En af QR-koderne indgår allerede i en planlagt rapport med samme frekvens, eller en rapport med den frekvens bruger omfanget
all. Rediger eller slet den rapport, eller vælg en anden frekvens.404 "Scheduled report not found."
404 "Scheduled report not found."
id matcher ikke en planlagt rapport i dit arbejdsområde. Hent det fra Vis planlagte rapporter.Rapporten mangler dagens scanninger
Rapporten mangler dagens scanninger
Rapporter dækker kun den seneste afsluttede periode. Brug Statistik til tal i realtid.