L’API GetQR est en version bêta et réservée à certains espaces de travail. Certains détails peuvent changer avant la disponibilité générale.
Pour un résumé prêt à l’emploi par QR code, consultez Rapports.
Signification des chiffres
- Scans. Chaque décompte se trouve dans le champ
clicks. Un scan est compté chaque fois que quelqu’un ouvre le lien court du QR code. - Scans uniques. Avec
unique=true, chaque visiteur n’est compté qu’une fois sur la plage de dates. - Périmètre. Les chiffres proviennent du lien court du QR code. Un QR code sans lien court n’a aucun scan à compter.
- Historique. Les statistiques ne peuvent pas être réinitialisées via l’API. Supprimer un QR code ne supprime pas l’historique de ses scans.
En-têtes
string
requis
Bearer suivi de votre clé API. Consultez Authentification.Paramètres de requête
Les deux endpoints acceptent ces paramètres. Tous sont facultatifs.string
défaut:"count"
Dimension de répartition.
count renvoie le total. Consultez Répartitions pour chaque valeur et la forme de sa réponse.string
défaut:"30d"
Plage de dates prédéfinie :
24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd ou all. Consultez Plages de dates. Ignoré si vous envoyez start.string
Début d’une plage personnalisée, ISO 8601, par exemple
2026-08-01 ou 2026-08-01T00:00:00Z. Prioritaire sur interval. Doit être antérieur à end.string
Fin d’une plage personnalisée, ISO 8601. Par défaut, la fin de la journée en cours. S’utilise avec
start ou interval=all, et est ignoré avec les autres intervalles.string
défaut:"UTC"
Fuseau horaire IANA utilisé pour aligner les tranches de
timeseries, par exemple America/New_York. Un fuseau horaire inconnu renvoie 422.boolean
défaut:"false"
true compte les scans uniques au lieu du total des scans.Plages de dates
Pour une plage personnalisée, envoyez
start et, éventuellement, end. Les plages de 2 jours maximum utilisent des tranches horaires, celles de plus de 180 jours des tranches mensuelles, et toutes les autres des tranches journalières.
Filtres de dimension
Limitez les résultats aux scans qui correspondent à un filtre. Les différents filtres sont combinés avec AND. Quand un filtre accepte plusieurs valeurs, séparez-les par des virgules : les valeurs sont combinées avec OR.
Un code pays ou continent inconnu renvoie
422. Les noms d’appareils, de navigateurs et de systèmes d’exploitation sont comparés avec une majuscule initiale : mobile fonctionne donc comme Mobile.
Par exemple, les scans depuis les États-Unis ou le Canada sur appareils mobiles : ?country=US,CA&device=Mobile.
Répartitions
count renvoie un objet. Toutes les autres valeurs renvoient un tableau, trié par clicks du plus élevé au plus faible (timeseries est trié par date).
Un
groupBy inconnu renvoie 422 avec la liste des valeurs valides.
Réponse quand groupBy=count :
groupBy=countries :
Obtenir les statistiques d’un QR code
GET /api/v1/qrs/{qrId}/analytics
Renvoie les statistiques de scans d’un QR code, limitées à son lien court. Accepte les paramètres de requête et les filtres de dimension ci-dessus.
Obtenir les statistiques de l’espace de travail
GET /api/v1/analytics
Renvoie les statistiques de scans de tous les QR codes de votre espace de travail. Accepte les paramètres de requête et les filtres de dimension ci-dessus, ainsi que ces paramètres de périmètre.
string
Avec
key, limite les résultats au lien court ayant ce domaine, par exemple getqr.sh. Le domaine doit appartenir à votre espace de travail.string
Slug du lien court, par exemple
x7Kd2p1. S’utilise avec domain. Les deux se trouvent dans l’objet QR code.string
Types de QR codes à inclure, séparés par des virgules :
website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email ou event. Consultez Types de QR codes.Problèmes courants
400 "QR has no associated link."
400 "QR has no associated link."
Le QR code n’a pas de lien court : il n’y a donc aucun scan à compter.
404 lors d'un filtrage par domain et key
404 lors d'un filtrage par domain et key
Aucun lien court avec ce domaine et ce slug n’existe dans votre espace de travail. Copiez
domain et key depuis l’objet QR code.422 sur groupBy, interval ou un filtre
422 sur groupBy, interval ou un filtre
La valeur n’est pas prise en charge. Le message d’erreur indique le paramètre et liste les valeurs valides.
Les chiffres ne correspondent pas au tableau de bord
Les chiffres ne correspondent pas au tableau de bord
Vérifiez que vous utilisez la même plage de dates et le même fuseau horaire, et si vous comptez les scans uniques (
unique=true) ou le total des scans.