Skip to main content
POST
Met en file d’attente une tâche asynchrone qui génère un rapport de données de scan et/ou d’analyses couvrant un ensemble de codes QR, une étiquette ou un dossier.
Nécessite une clé d’API de gestion avec le quota MANAGEMENT_API (ou MANAGEMENT_API_SANDBOX) — voir la présentation de l’API de gestion — plus le quota EXPORT_ANALYTICS_REPORT et la permission ANALYTICS_CAN_EXPORT_REPORT propres au compte.
string
requis
Ce que filter_data identifie : qrcode, tag ou folder.
string
requis
Une chaîne encodée en JSON identifiant la ou les cible(s) — par ex. un tableau JSON de qrid lorsque filter_type vaut qrcode.
string
requis
Date de début (YYYY-MM-DD).
string
requis
Date de fin (YYYY-MM-DD).
string
défaut:"both"
scan_data, analytics ou both.
string
défaut:"csv"
Format de fichier pour la partie analyses : csv, xls, xlsx, png, jpeg ou pdf.
string
défaut:"csv"
Format de fichier pour la partie données de scan : mêmes options que analytics_format.
object
Charge JSON de filtre supplémentaire optionnelle, superposée à filter_type/filter_data.
boolean
défaut:"false"
Exclut du rapport les scans identifiés comme trafic de bots.
boolean
défaut:"false"
Indique s’il faut conserver ce rapport comme préréglage réutilisable enregistré — voir Mettre à jour un rapport d’analyses enregistré.
string
Un nom pour le préréglage enregistré, requis si is_saved vaut true. Doit être unique par compte — un doublon renvoie 400.
L’appel renvoie 201 immédiatement une fois la tâche mise en file d’attente, avec status: "new" — le rapport lui-même est généré en arrière-plan et le compte reçoit un e-mail à la fin. Interrogez Lister les rapports d’analyses pour connaître status et report_file.

Voir aussi

Autorisations

Authorization
string
header
requis

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: YOUR_API_KEY. 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.

Réponse

201 - application/json

Report job queued.