L’API di GetQR è in beta ed è disponibile per alcuni workspace selezionati. I dettagli possono cambiare prima del rilascio generale.
Header
string
obbligatorio
Bearer seguito dalla tua chiave API. Consulta Autenticazione.string
application/json. Obbligatorio nelle richieste POST e PATCH.Ambito
Sia i report una tantum sia quelli programmati accettano unoscope:
Un report elenca al massimo 50 QR code. Con
all, sono i QR code attivi creati più di recente; i codici in pausa sono esclusi. Con selected e single, i codici in pausa sono inclusi. I QR code senza link breve non hanno scansioni e vengono saltati.
Periodo
Il periodo è sempre l’ultimo concluso, quindi un report non include mai i dati parziali di oggi. I suoi limiti sono la mezzanotte nel fuso orario del report.Esporta un report
POST /api/v1/reports
Genera un report per l’ultimo periodo concluso e lo restituisce nella risposta.
string
obbligatorio
json restituisce il report nel corpo della risposta. csv e pdf restituiscono un file da scaricare.string[]
QR code da includere. Obbligatorio per
selected (uno o più ID) e single (esattamente un ID). Omettilo per all.string
predefinito:"UTC"
Fuso orario IANA a cui sono allineati i limiti del periodo, ad esempio
America/New_York. Un fuso orario sconosciuto restituisce 422.string
predefinito:"en"
Lingua del PDF, ad esempio
en o de. Un valore non supportato torna all’inglese. Ignorato da csv e json.string
Titolo mostrato sul PDF, fino a 40 caratteri. Ignorato da
csv e json.Risposta JSON
string
Primo giorno del periodo,
YYYY-MM-DD.string
Primo giorno dopo il periodo,
YYYY-MM-DD. Il periodo termina alla mezzanotte all’inizio di questo giorno.object[]
Una voce per ogni QR code.
Risposte CSV e PDF
Il corpo è il file.Content-Disposition gli dà un nome basato sul periodo, ad esempio report-2026-08-10_2026-08-17.csv. Il CSV ha una riga per QR code con le colonne QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS e Top browser.
L’oggetto report programmato
Un report programmato viene inviato via email all’account che lo ha creato, a mezzanotte nel suo fuso orario.string
ID del report programmato.
string | null
Etichetta mostrata nell’oggetto dell’email e nella dashboard.
string
daily, weekly o monthly.string
all, selected o single.string[] | null
QR code inclusi nel report con gli ambiti
selected e single. null se non sono stati inviati ID.null
Sempre
null. Riservato.boolean
Indica se all’email è allegato un PDF.
string
active o paused.string
Fuso orario IANA a cui sono allineati l’orario di invio e il periodo.
string
Lingua dell’email e del PDF.
string
Quando è previsto il prossimo invio, ISO 8601: la prossima mezzanotte (
daily), il prossimo lunedì (weekly) o il 1° del mese successivo (monthly), nel fuso orario del report.string | null
Quando è stata inviata l’ultima email, ISO 8601.
string
Data di creazione, ISO 8601.
string
Data dell’ultimo aggiornamento, ISO 8601.
Elenca i report programmati
GET /api/v1/reports/schedules
Restituisce i report programmati del tuo workspace, compresi quelli creati da altri membri, dal più recente. L’elenco è paginato: consulta Paginazione.
integer
predefinito:"1"
Pagina da restituire, 1 o superiore.
integer
predefinito:"100"
Risultati per pagina, da 1 a 100.
Pianifica un report
POST /api/v1/reports/schedules
Crea un report che viene inviato via email a intervalli regolari. nextRunAt viene calcolato in base alla frequenza e al fuso orario.
Un QR code può appartenere a un solo report programmato per frequenza. Una pianificazione sovrapposta restituisce
409 conflict.all si sovrappone a tutti gli altri report con la stessa frequenza. Anche i report in pausa contano.
string
obbligatorio
Ogni quanto viene inviato il report:
daily, weekly o monthly. Stabilisce anche il periodo coperto. Consulta Periodo.string
obbligatorio
Fuso orario IANA a cui sono allineati l’orario di invio e il periodo, ad esempio
America/New_York. Un fuso orario sconosciuto restituisce 422.string
obbligatorio
Lingua dell’email e del PDF, ad esempio
en o de. Un valore non supportato torna all’inglese. I PDF in zh, ja, ko e ar vengono generati in inglese.string[]
QR code da includere. Obbligatorio per
selected (uno o più ID) e single (esattamente un ID). Ogni ID deve corrispondere a un QR code del tuo workspace, altrimenti la richiesta restituisce 404.string
Etichetta mostrata nell’oggetto dell’email e nella dashboard, fino a 40 caratteri.
boolean
predefinito:"false"
Allega all’email una versione PDF del report.
Aggiorna un report programmato
PATCH /api/v1/reports/schedules/{id}
Modifica un report programmato, oppure lo mette in pausa e lo riprende. Invia solo i campi che vuoi modificare, almeno uno. Cambiare la frequenza o il fuso orario, oppure riprendere un report in pausa, ricalcola nextRunAt. La regola di un report per frequenza resta valida, quindi una modifica che crea una sovrapposizione restituisce 409.
string
obbligatorio
ID del report programmato. Prendilo dalla risposta dell’elenco o della creazione.
string
paused interrompe le email senza eliminare la pianificazione. active le riprende.string
Etichetta, fino a 40 caratteri.
string
daily, weekly o monthly.string
all, selected o single.string[]
QR code da includere. Ogni ID deve corrispondere a un QR code del tuo workspace.
boolean
Allega un PDF all’email.
string
Fuso orario IANA.
string
Lingua dell’email e del PDF.
Elimina un report programmato
DELETE /api/v1/reports/schedules/{id}
Elimina la pianificazione e interrompe tutti gli invii successivi.
string
obbligatorio
ID del report programmato.
Problemi comuni
404 durante l'esportazione di un report
404 durante l'esportazione di un report
Con l’ambito
selected o single, nessuno dei qrIds corrisponde a un QR code con link breve nel tuo workspace. Controlla gli ID.404 "QR not found." durante la pianificazione di un report
404 "QR not found." durante la pianificazione di un report
Uno dei
qrIds non è un QR code del tuo workspace, oppure è stato eliminato. Controlla gli ID con Elenca i QR code.409 durante la pianificazione di un report
409 durante la pianificazione di un report
Uno dei QR code appartiene già a un report programmato con la stessa frequenza, oppure un report con quella frequenza usa l’ambito
all. Modifica o elimina quel report, oppure scegli una frequenza diversa.404 "Scheduled report not found."
404 "Scheduled report not found."
L’
id non corrisponde a un report programmato del tuo workspace. Prendilo da Elenca i report programmati.Nel report mancano le scansioni di oggi
Nel report mancano le scansioni di oggi
I report coprono solo l’ultimo periodo concluso. Usa Statistiche per i dati in tempo reale.