Die GetQR API befindet sich in der Beta-Phase und steht ausgewählten Workspaces zur Verfügung. Details können sich bis zur allgemeinen Veröffentlichung noch ändern.
Eine fertige Zusammenfassung pro QR-Code finden Sie unter Berichte.
Was die Zahlen bedeuten
- Scans. Jede Zählung steht im Feld
clicks. Ein Scan wird jedes Mal gezählt, wenn jemand den Kurzlink des QR-Codes öffnet. - Eindeutige Scans. Mit
unique=truewird jeder Besucher im Zeitraum nur einmal gezählt. - Umfang. Die Zahlen stammen vom Kurzlink des QR-Codes. Ein QR-Code ohne Kurzlink hat keine Scans, die gezählt werden könnten.
- Verlauf. Analytics lassen sich über die API nicht zurücksetzen. Das Löschen eines QR-Codes entfernt seine bisherigen Scandaten nicht.
Header
string
erforderlich
Bearer gefolgt von Ihrem API-Schlüssel. Siehe Authentifizierung.Query-Parameter
Beide Endpunkte akzeptieren diese Parameter. Alle sind optional.string
Standard:"count"
Dimension der Aufschlüsselung.
count liefert die Gesamtzahl. Alle Werte und ihre Antwortstruktur finden Sie unter Aufschlüsselungen.string
Standard:"30d"
Vordefinierter Zeitraum:
24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd oder all. Siehe Zeiträume. Wird ignoriert, wenn Sie start senden.string
Beginn eines eigenen Zeitraums, ISO 8601, zum Beispiel
2026-08-01 oder 2026-08-01T00:00:00Z. Hat Vorrang vor interval. Muss vor end liegen.string
Ende eines eigenen Zeitraums, ISO 8601. Standard ist das Ende des heutigen Tages. Wird zusammen mit
start oder interval=all verwendet und bei den anderen Intervallen ignoriert.string
Standard:"UTC"
IANA-Zeitzone, an der die
timeseries-Intervalle ausgerichtet werden, zum Beispiel America/New_York. Eine unbekannte Zeitzone liefert 422.boolean
Standard:"false"
true zählt eindeutige Scans statt aller Scans.Zeiträume
Für einen eigenen Zeitraum senden Sie
start und optional end. Zeiträume bis 2 Tage verwenden stündliche Intervalle, Zeiträume über 180 Tage monatliche und alles dazwischen tägliche.
Dimensionsfilter
Beschränken Sie die Ergebnisse auf Scans, die einem Filter entsprechen. Verschiedene Filter werden mit UND verknüpft. Nimmt ein Filter mehrere Werte an, trennen Sie diese durch Kommas: Die Werte werden mit ODER verknüpft.
Ein unbekannter Länder- oder Kontinentcode liefert
422. Namen von Geräten, Browsern und Betriebssystemen werden mit großem Anfangsbuchstaben abgeglichen, daher funktioniert mobile wie Mobile.
Zum Beispiel Scans aus den USA oder Kanada auf Mobilgeräten: ?country=US,CA&device=Mobile.
Aufschlüsselungen
count liefert ein Objekt. Alle anderen Werte liefern ein Array, absteigend nach clicks sortiert (timeseries ist nach Zeit sortiert).
Ein unbekannter Wert für
groupBy liefert 422 mit der Liste der gültigen Werte.
Antwort bei groupBy=count:
groupBy=countries:
Analytics für einen QR-Code abrufen
GET /api/v1/qrs/{qrId}/analytics
Liefert Scan-Statistiken für einen QR-Code, beschränkt auf seinen Kurzlink. Akzeptiert die oben beschriebenen Query-Parameter und Dimensionsfilter.
string
erforderlich
ID des QR-Codes. Nehmen Sie sie aus der Antwort der Liste oder der Erstellung unter QR-Codes.
Analytics für den Workspace abrufen
GET /api/v1/analytics
Liefert Scan-Statistiken über alle QR-Codes Ihres Workspace. Akzeptiert die oben beschriebenen Query-Parameter und Dimensionsfilter sowie diese Parameter zur Eingrenzung.
string
Beschränkt die Ergebnisse zusammen mit
key auf den Kurzlink mit dieser Domain, zum Beispiel getqr.sh. Die Domain muss zu Ihrem Workspace gehören.string
Slug des Kurzlinks, zum Beispiel
x7Kd2p1. Verwenden Sie ihn zusammen mit domain. Beide stehen im QR-Code-Objekt.string
Kommagetrennte QR-Code-Typen, die einbezogen werden:
website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email oder event. Siehe QR-Typen.Häufige Probleme
400 "QR has no associated link."
400 "QR has no associated link."
Der QR-Code hat keinen Kurzlink, daher gibt es keine Scans zu zählen.
404 beim Filtern nach domain und key
404 beim Filtern nach domain und key
In Ihrem Workspace gibt es keinen Kurzlink mit dieser Domain und diesem Slug. Kopieren Sie
domain und key aus dem QR-Code-Objekt.422 bei groupBy, interval oder einem Filter
422 bei groupBy, interval oder einem Filter
Der Wert wird nicht unterstützt. Die Fehlermeldung nennt den Parameter und listet die gültigen Werte auf.
Die Zahlen stimmen nicht mit dem Dashboard überein
Die Zahlen stimmen nicht mit dem Dashboard überein
Prüfen Sie, ob Sie denselben Zeitraum und dieselbe Zeitzone verwenden und ob Sie eindeutige Scans (
unique=true) oder alle Scans zählen.