Skip to main content
POST
Gibt aggregierte Scan-Analysen für einen oder mehrere QR-Codes zurück, gruppiert nach den von Ihnen angeforderten Metriktyp(en).
Dies ist ein ausschließlich POST-Endpunkt, obwohl der Name eine Abfrage nahelegt — eine GET-Anfrage gibt 405 Method Not Allowed zurück. Die Query-Parameter (from, to, type) wählen den Datumsbereich und die Metriken aus; der Request-Body wählt aus, welche QR-Codes einbezogen werden.
Erfordert einen Management-API-Schlüssel mit MANAGEMENT_API- (oder MANAGEMENT_API_SANDBOX-)Quota — siehe die Management-API-Übersicht — sowie die eigene QR_ANALYTICS_BASIC-Quota des Kontos. Alles über die Metrik count hinaus erfordert zusätzlich QR_ANALYTICS_ADVANCED; ohne diese wird jede Anfrage stillschweigend auf count herabgestuft, unabhängig davon, welchen type Sie angefordert haben.

Anfrage

Live verifiziert — ein leeres qr-Array hier spiegelt einen QR-Code mit null Scans im angeforderten Zeitfenster wider, keinen Fehler. qr_meta ist eine zusätzliche Zuordnung name -> {qrid, category, category_slug}, die nur hinzugefügt wird, wenn qr unter den angeforderten types ist, damit ein Aufrufer von einer namensbasierten Zeile zu ihrer qrid zurückverlinken kann. Sie ist additiv: Die Form, die Aufrufer bereits unter jedem Metrikschlüssel parsen, bleibt unverändert.

Query-Parameter

string
erforderlich
Startdatum (YYYY-MM-DD), inklusive.
string
erforderlich
Enddatum (YYYY-MM-DD), inklusive.
string
erforderlich
Kommagetrennte Metriktypen, z. B. qr,device,geography. Gängige Werte: count, qr, date, day, time, utm, device, os, browser, handset, geography, geo_location, age. Erfordert die QR_ANALYTICS_ADVANCED-Quota des Kontos für alles über count hinaus.
string
Standard:"date"
Gruppierung für Zeitreihen-Metriktypen, z. B. date, week, month.
boolean
Standard:"false"
Schließt als Bot-Traffic identifizierte Scans aus den Ergebnissen aus.
boolean
Übergeben Sie true für Aufrufe im Stil der Dashboard-Übersicht — umgeht das unten beschriebene QR-Zahl-/Datumsbereich-Volumenlimit und zählt nicht zum “Analysen abgerufen”-Aktivitätssignal des Kontos.

Request-Body

array
erforderlich
Liste von Bezeichnern, auf die die Analysen beschränkt werden — der Typ des Bezeichners hängt von filter_by ab.
string
Standard:"qrid"
Einer von qrid (QR-Code-IDs), id (interne numerische IDs), tags (Tag-Namen) oder folder (Ordner-IDs).

Antwort

Die Antwort ist ein Objekt, das nach jedem angeforderten Metrik-type verschlüsselt ist, plus qr_meta sofern zutreffend (siehe oben). Die Form variiert je nach Metriktyp — count gibt Gesamtzahlen der Scans zurück, device/os/browser/geography geben Aufschlüsselungen nach dieser Dimension zurück, und Zeitreihen-Typen (date/day/time) geben eine nach group gebündelte Serie zurück.
Das Anfordern zu vieler QR-Codes über einen zu weiten Datumsbereich gibt einen 400-Fehler unter q zurück: "High Volume of data. Either select lower than {N} QR Codes/{N} days time period or generate Analytics Export instead." In der Praxis setzen sowohl Analysen exportieren als auch Rohe Analysen exportieren genau dasselbe Limit durch — alle drei Endpunkte teilen sich denselben Code-Pfad zur Anfragevalidierung — die tatsächliche Lösung für diesen Fehler besteht also darin, q oder den Datumsbereich einzugrenzen, nicht den Endpunkt zu wechseln.

Verwandte Themen

Autorisierungen

Authorization
string
header
erforderlich

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

Abfrageparameter

from
string<date>
erforderlich
to
string<date>
erforderlich
type
string
erforderlich

Comma-separated metric types, e.g. qr.

group
string
Standard:date

Grouping for time-series metric types, e.g. date/week/month.

exclude_bot_scan
boolean
Standard:false
overview
boolean

Bypasses the volume cap; used by dashboard overview widgets.

Body

application/json
q
string[]
erforderlich

Query data — a list of identifiers of the type named in filter_by.

filter_by
enum<string>
Standard:qrid
Verfügbare Optionen:
qrid,
tags,
id,
folder

Antwort

200 - application/json

Analytics data, grouped by the requested type(s). A qr_meta name->{qrid, category, category_slug} map is attached whenever qr is among the requested types.