Skip to main content
POST
Exportiert rohe, scanweise Analyse-Datensätze — eine Zeile pro Scan-Ereignis, statt der aggregierten Aufschlüsselungen, die QR-Analysen und Analysen exportieren zurückgeben.
Dies ist ein ausschließlich POST-Endpunkt — eine GET-Anfrage gibt 405 Method Not Allowed zurück. Die Spezifikation management-api.json führte ihn zuvor als GET auf; dies wurde korrigiert.
Erfordert einen Management-API-Schlüssel mit MANAGEMENT_API-Quota — siehe die Management-API-Übersicht — sowie die EXPORT_ANALYTICS_REPORT-Quota und die ANALYTICS_CAN_EXPORT_RAW-Berechtigung des Kontos (zu unterscheiden von der ANALYTICS_CAN_EXPORT-Berechtigung, die der aggregierte Export erfordert — eine Rolle kann die eine ohne die andere besitzen). Ein 403-Fehler mit "Your plan does not have export analytics report quota." bedeutet, dass der Plan keine Exporte enthält.

Anfrage

Dieser Endpunkt gibt immer eine Binärdatei zurück, kein JSON.

Query-Parameter

string
erforderlich
Startdatum (YYYY-MM-DD), inklusive.
string
erforderlich
Enddatum (YYYY-MM-DD), inklusive.
string
erforderlich
csv, xls oder xlsx. Anders als bei Analysen exportieren ist pdf hier kein unterstütztes Format. Jeder andere Wert (oder das Weglassen) gibt einen 400-Fehler mit "Invalid file format" zurück.
string
Übergeben Sie raw_bot, um nur als Bot identifizierte Scan-Datensätze statt aller Scans zu exportieren. Jeder andere Wert wird überschrieben — dieser Endpunkt exportiert unabhängig von der Übergabe immer Rohdaten.

Request-Body

Dieselbe Form wie bei QR-Analysenq (erforderlich) und filter_by (Standard qrid) beschränken, welcher QR-Codes Rohscans einbezogen werden, und es gilt dieselbe QR-Zahl-/Datumsbereich-Volumengrenze.
array
erforderlich
Bezeichner, auf die der Export beschränkt wird — der Typ hängt von filter_by ab.
string
Standard:"qrid"
qrid, id, tags oder folder.

Antwortformate

Gibt eine einzelne CSV-Datei (text/csv, analytics_raw.csv) mit rohen Scan-Zeilen zurück.
Wenn das Konto Event-Tracking-Analysen aktiviert hat und file_format nicht csv ist, wird automatisch ein zweites Blatt/Abschnitt mit rohen Event-Tracking-Datensätzen angehängt (Sitzungs-ID, Zeitstempel, QR-Code-ID/-Name, benutzerdefinierte Event-Tracking-ID, URL-Hash, URL). Das Anfordern von csv gibt immer nur Scan-Datensätze zurück — Event-Tracking-Zeilen werden für dieses Format speziell weggelassen.

Verwandte Themen

  • QR-Analysen — das aggregierte, JSON-Äquivalent dieser rohen Scan-Datensätze.
  • Analysen exportieren — exportieren Sie aggregierte Metrik-Aufschlüsselungen statt Daten auf Zeilenebene.
  • Management-API-Übersicht — das Auth-Schema und die Quota-Architektur, zu der dieser Endpunkt gehört.

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
file_format
enum<string>
erforderlich
Verfügbare Optionen:
csv,
xls,
xlsx
type
enum<string>

Pass raw_bot for a bot-only export; any other value is overwritten to raw.

Verfügbare Optionen:
raw_bot

Body

application/json
q
string[]
erforderlich
filter_by
enum<string>
Standard:qrid
Verfügbare Optionen:
qrid,
tags,
id,
folder

Antwort

Binary file download — text/csv for csv, spreadsheet mimetype for xls/xlsx.