Skip to main content
POST
Stellt einen asynchronen Job in die Warteschlange, der einen Scan-Daten- und/oder Analytics-Bericht über eine Reihe von QR-Codes, ein Tag oder einen Ordner hinweg erzeugt.
Erfordert einen Management-API-Schlüssel mit MANAGEMENT_API- (oder MANAGEMENT_API_SANDBOX-)Quota — siehe die Übersicht über die Management API — sowie die eigene EXPORT_ANALYTICS_REPORT-Quota und ANALYTICS_CAN_EXPORT_REPORT-Berechtigung des Kontos.
string
erforderlich
Was filter_data identifiziert: qrcode, tag oder folder.
string
erforderlich
Ein JSON-kodierter String, der das/die Ziel(e) identifiziert — z. B. ein JSON-Array von qrids, wenn filter_type qrcode ist.
string
erforderlich
Startdatum (YYYY-MM-DD).
string
erforderlich
Enddatum (YYYY-MM-DD).
string
Standard:"both"
scan_data, analytics oder both.
string
Standard:"csv"
Dateiformat für den Analytics-Teil: csv, xls, xlsx, png, jpeg oder pdf.
string
Standard:"csv"
Dateiformat für den Scan-Daten-Teil: dieselben Optionen wie analytics_format.
object
Optionale zusätzliche JSON-Filter-Payload, die über filter_type/filter_data gelegt wird.
boolean
Standard:"false"
Schließt als Bot-Traffic erkannte Scans aus dem Bericht aus.
boolean
Standard:"false"
Ob dieser Bericht als wiederverwendbare gespeicherte Voreinstellung beibehalten werden soll — siehe Gespeicherten Analytics-Bericht aktualisieren.
string
Ein Name für die gespeicherte Voreinstellung, erforderlich, wenn is_saved true ist. Muss pro Konto eindeutig sein — ein Duplikat gibt 400 zurück.
Der Aufruf gibt sofort 201 zurück, sobald der Job in die Warteschlange gestellt wurde, mit status: "new" — der Bericht selbst wird im Hintergrund erzeugt, und das Konto wird bei Abschluss per E-Mail benachrichtigt. Fragen Sie Analytics-Berichte auflisten für status und report_file ab.

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. api.scanova.io) — the same key sent to the regular API host will not authenticate.

Antwort

201 - application/json

Report job queued.