Skip to main content
POST
Devuelve analíticas de escaneo agregadas para uno o más códigos QR, agrupadas por el tipo o tipos de métrica que solicites.
Este es un endpoint solo POST a pesar de que el nombre sugiere una consulta — una solicitud GET devuelve 405 Method Not Allowed. Los parámetros de consulta (from, to, type) seleccionan el rango de fechas y las métricas; el cuerpo de la solicitud selecciona qué códigos QR incluir.
Requiere una clave de la API de gestión con cuota MANAGEMENT_API (o MANAGEMENT_API_SANDBOX) — consulta el resumen de la API de gestión — además de la propia cuota QR_ANALYTICS_BASIC de la cuenta. Solicitar algo más allá de la métrica count requiere adicionalmente QR_ANALYTICS_ADVANCED; sin ella, toda solicitud se degrada silenciosamente a count independientemente del type que hayas pedido.

Solicitud

Verificado en vivo — un array qr vacío aquí refleja un código QR sin escaneos en la ventana solicitada, no un error. qr_meta es un mapa adicional name -> {qrid, category, category_slug}, añadido solo cuando qr está entre los type solicitados, para que quien llama pueda enlazar en profundidad desde una fila indexada por nombre de vuelta a su qrid. Es aditivo: la forma que quien llama ya interpreta bajo cada clave de métrica no cambia.

Parámetros de consulta

string
requerido
Fecha de inicio (YYYY-MM-DD), inclusiva.
string
requerido
Fecha de fin (YYYY-MM-DD), inclusiva.
string
requerido
Tipos de métrica separados por comas, p. ej. qr,device,geography. Valores comunes: count, qr, date, day, time, utm, device, os, browser, handset, geography, geo_location, age. Requiere la cuota QR_ANALYTICS_ADVANCED de la cuenta para cualquier cosa más allá de count.
string
predeterminado:"date"
Agrupación para tipos de métrica de serie temporal, p. ej. date, week, month.
boolean
predeterminado:"false"
Excluye de los resultados los escaneos identificados como tráfico de bots.
boolean
Pasa true para llamadas de estilo resumen del panel — evita el límite de volumen de cantidad de QR/rango de fechas descrito a continuación, y no cuenta para la señal de actividad “analíticas obtenidas” de la cuenta.

Cuerpo de la solicitud

array
requerido
Lista de identificadores para limitar las analíticas — el tipo de identificador depende de filter_by.
string
predeterminado:"qrid"
Uno de qrid (IDs de código QR), id (IDs numéricos internos), tags (nombres de etiquetas) o folder (IDs de carpeta).

Respuesta

La respuesta es un objeto indexado por cada type de métrica solicitado, más qr_meta cuando corresponda (ver arriba). La forma varía según el tipo de métrica — count devuelve totales de escaneo, device/os/browser/geography devuelven desgloses por esa dimensión, y los tipos de serie temporal (date/day/time) devuelven una serie agrupada por group.
Solicitar demasiados códigos QR en un rango de fechas demasiado amplio devuelve un 400 bajo q: "High Volume of data. Either select lower than {N} QR Codes/{N} days time period or generate Analytics Export instead." En la práctica, tanto Exportar analíticas como Exportar analíticas en bruto aplican exactamente el mismo límite — los tres endpoints comparten la misma ruta de código de validación de solicitudes — así que la solución real para este error es reducir q o el rango de fechas, no cambiar de endpoint.

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

Parámetros de consulta

from
string<date>
requerido
to
string<date>
requerido
type
string
requerido

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

group
string
predeterminado:date

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

exclude_bot_scan
boolean
predeterminado:false
overview
boolean

Bypasses the volume cap; used by dashboard overview widgets.

Cuerpo

application/json
q
string[]
requerido

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

filter_by
enum<string>
predeterminado:qrid
Opciones disponibles:
qrid,
tags,
id,
folder

Respuesta

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.