Skip to main content
POST
Encola un trabajo asíncrono que genera un informe de datos de escaneo y/o analíticas que abarca un conjunto de códigos QR, una etiqueta o una carpeta.
Requiere una clave de API de gestión con cuota MANAGEMENT_API (o MANAGEMENT_API_SANDBOX) — consulte el resumen de la API de gestión — más la cuota EXPORT_ANALYTICS_REPORT y el permiso ANALYTICS_CAN_EXPORT_REPORT propios de la cuenta.
string
requerido
Qué identifica filter_data: qrcode, tag o folder.
string
requerido
Una cadena codificada en JSON que identifica el/los objetivo(s) — p. ej. un array JSON de qrids cuando filter_type es qrcode.
string
requerido
Fecha de inicio (YYYY-MM-DD).
string
requerido
Fecha de fin (YYYY-MM-DD).
string
predeterminado:"both"
scan_data, analytics o both.
string
predeterminado:"csv"
Formato de archivo para la parte de analíticas: csv, xls, xlsx, png, jpeg o pdf.
string
predeterminado:"csv"
Formato de archivo para la parte de datos de escaneo: las mismas opciones que analytics_format.
object
Payload JSON de filtro adicional opcional, superpuesto a filter_type/filter_data.
boolean
predeterminado:"false"
Excluye del informe los escaneos identificados como tráfico de bots.
boolean
predeterminado:"false"
Si se debe conservar este informe como una configuración predefinida reutilizable — consulte Actualizar un informe de analíticas guardado.
string
Un nombre para la configuración predefinida guardada, requerido si is_saved es true. Debe ser único por cuenta — un duplicado devuelve 400.
La llamada devuelve 201 inmediatamente una vez que el trabajo está en cola, con status: "new" — el informe en sí se genera en segundo plano y la cuenta recibe un correo electrónico al completarse. Consulte Listar informes de analíticas para conocer status y report_file.

Relacionado

Autorizaciones

Authorization
string
header
requerido

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.

Respuesta

201 - application/json

Report job queued.