API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.
Anteturi
string
obligatoriu
Bearer urmat de cheia dvs. API. Consultați Autentificare.string
application/json. Obligatoriu pentru cererile POST și PATCH.Domeniu
Atât rapoartele unice, cât și cele programate primesc unscope:
Un raport include cel mult 50 de coduri QR. Cu
all, acestea sunt codurile QR active create cel mai recent; codurile puse în pauză sunt excluse. Cu selected și single, codurile puse în pauză sunt incluse. Codurile QR fără link scurt nu au scanări și sunt omise.
Perioadă
Perioada este întotdeauna ultima perioadă încheiată, așa că un raport nu include niciodată datele parțiale de azi. Limitele ei sunt la miezul nopții, în fusul orar al raportului.Exportarea unui raport
POST /api/v1/reports
Generează un raport pentru ultima perioadă încheiată și îl returnează în răspuns.
string
obligatoriu
json returnează raportul în corpul răspunsului. csv și pdf returnează un fișier de descărcat.string[]
Codurile QR incluse. Obligatoriu pentru
selected (unul sau mai multe ID-uri) și single (exact un ID). Omiteți-l pentru all.string
implicit:"UTC"
Fusul orar IANA după care se aliniază limitele perioadei, de exemplu
America/New_York. Un fus orar necunoscut returnează 422.string
implicit:"en"
Limba PDF-ului, de exemplu
en sau de. O valoare neacceptată revine la engleză. Ignorat de csv și json.string
Titlul afișat pe PDF, până la 40 de caractere. Ignorat de
csv și json.Răspunsul JSON
string
Prima zi a perioadei,
YYYY-MM-DD.string
Prima zi de după perioadă,
YYYY-MM-DD. Perioada se încheie la miezul nopții, la începutul acestei zile.object[]
Câte o intrare pentru fiecare cod QR.
Răspunsuri CSV și PDF
Corpul este fișierul.Content-Disposition îl denumește după perioadă, de exemplu report-2026-08-10_2026-08-17.csv. Fișierul CSV are câte un rând pentru fiecare cod QR, cu coloanele QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS și Top browser.
Obiectul raport programat
Un raport programat este trimis prin e-mail contului care l-a creat, la miezul nopții în fusul său orar.string
ID-ul raportului programat.
string | null
Eticheta afișată în subiectul e-mailului și în panou.
string
daily, weekly sau monthly.string
all, selected sau single.string[] | null
Codurile QR incluse în raport cu domeniile
selected și single. null când nu au fost trimise ID-uri.null
Întotdeauna
null. Rezervat.boolean
Dacă la e-mail este atașat un PDF.
string
active sau paused.string
Fusul orar IANA după care se aliniază ora de trimitere și perioada.
string
Limba e-mailului și a PDF-ului.
string
Când este programat următorul e-mail, ISO 8601: următorul miez al nopții (
daily), următoarea zi de luni (weekly) sau data de 1 a lunii următoare (monthly), în fusul orar al raportului.string | null
Când a fost trimis ultimul e-mail, ISO 8601.
string
Data creării, ISO 8601.
string
Data ultimei actualizări, ISO 8601.
Listarea rapoartelor programate
GET /api/v1/reports/schedules
Returnează rapoartele programate ale spațiului dvs. de lucru, inclusiv cele create de alți membri, cele mai noi primele. Lista este paginată: consultați Paginare.
integer
implicit:"1"
Pagina returnată, 1 sau mai mult.
integer
implicit:"100"
Rezultate pe pagină, de la 1 la 100.
Programarea unui raport
POST /api/v1/reports/schedules
Creează un raport care este trimis periodic prin e-mail. nextRunAt se calculează pe baza frecvenței și a fusului orar.
Un cod QR poate face parte dintr-un singur raport programat pentru fiecare frecvență. O programare care se suprapune returnează
409 conflict.all se suprapune cu orice alt raport cu aceeași frecvență. Rapoartele puse în pauză se iau și ele în calcul.
string
obligatoriu
Cât de des este trimis raportul:
daily, weekly sau monthly. Stabilește și perioada acoperită. Consultați Perioadă.string
obligatoriu
Fusul orar IANA după care se aliniază ora de trimitere și perioada, de exemplu
America/New_York. Un fus orar necunoscut returnează 422.string
obligatoriu
Limba e-mailului și a PDF-ului, de exemplu
en sau de. O valoare neacceptată revine la engleză. PDF-urile în zh, ja, ko și ar sunt generate în engleză.string[]
Codurile QR incluse. Obligatoriu pentru
selected (unul sau mai multe ID-uri) și single (exact un ID). Fiecare ID trebuie să fie al unui cod QR din spațiul dvs. de lucru, altfel cererea returnează 404.string
Eticheta afișată în subiectul e-mailului și în panou, până la 40 de caractere.
boolean
implicit:"false"
Atașează la e-mail o versiune PDF a raportului.
Actualizarea unui raport programat
PATCH /api/v1/reports/schedules/{id}
Modifică un raport programat sau îl pune în pauză și îl reia. Trimiteți doar câmpurile pe care vreți să le modificați, cel puțin unul. Schimbarea frecvenței sau a fusului orar ori reluarea unui raport pus în pauză recalculează nextRunAt. Regula unui singur raport pentru fiecare frecvență se aplică în continuare, așa că o modificare care se suprapune returnează 409.
string
obligatoriu
ID-ul raportului programat. Preluați-l din răspunsul listei sau al creării.
string
paused oprește e-mailurile fără a șterge programarea. active le reia.string
Eticheta, până la 40 de caractere.
string
daily, weekly sau monthly.string
all, selected sau single.string[]
Codurile QR incluse. Fiecare ID trebuie să fie al unui cod QR din spațiul dvs. de lucru.
boolean
Atașează un PDF la e-mail.
string
Fusul orar IANA.
string
Limba e-mailului și a PDF-ului.
Ștergerea unui raport programat
DELETE /api/v1/reports/schedules/{id}
Șterge programarea și oprește toate e-mailurile viitoare.
string
obligatoriu
ID-ul raportului programat.
Probleme frecvente
404 la exportarea unui raport
404 la exportarea unui raport
Cu domeniul
selected sau single, niciunul dintre qrIds nu corespunde unui cod QR cu link scurt din spațiul dvs. de lucru. Verificați ID-urile.404 "QR not found." la programarea unui raport
404 "QR not found." la programarea unui raport
Unul dintre
qrIds nu este un cod QR din spațiul dvs. de lucru sau a fost șters. Verificați ID-urile cu Listarea codurilor QR.409 la programarea unui raport
409 la programarea unui raport
Unul dintre codurile QR face deja parte dintr-un raport programat cu aceeași frecvență sau un raport cu acea frecvență folosește domeniul
all. Editați sau ștergeți acel raport ori alegeți o altă frecvență.404 "Scheduled report not found."
404 "Scheduled report not found."
id nu corespunde unui raport programat din spațiul dvs. de lucru. Preluați-l din Listarea rapoartelor programate.Raportul nu include scanările de azi
Raportul nu include scanările de azi
Rapoartele acoperă doar ultima perioadă încheiată. Folosiți Statistici pentru cifre în timp real.