Skip to main content
POST
Renvoie des analyses de scans agrégées pour un ou plusieurs QR codes, regroupées selon le ou les types de métrique que vous demandez.
Il s’agit d’un endpoint POST uniquement malgré ce que son nom pourrait laisser penser — une requête GET renvoie 405 Method Not Allowed. Les paramètres de requête (from, to, type) sélectionnent la plage de dates et les métriques ; le corps de la requête sélectionne les QR codes à inclure.
Nécessite une clé Management API avec le quota MANAGEMENT_API (ou MANAGEMENT_API_SANDBOX) — voir la vue d’ensemble de la Management API — ainsi que le propre quota QR_ANALYTICS_BASIC du compte. Demander autre chose que la métrique count nécessite en plus QR_ANALYTICS_ADVANCED ; sans cela, chaque requête est silencieusement rétrogradée vers count, quel que soit le type demandé.

Requête

Vérifié en conditions réelles — un tableau qr vide ici reflète un QR code n’ayant reçu aucun scan sur la période demandée, et non une erreur. qr_meta est une carte supplémentaire name -> {qrid, category, category_slug}, ajoutée uniquement lorsque qr fait partie des type demandés, afin qu’un appelant puisse créer un lien profond depuis une ligne indexée par nom vers son qrid. C’est additif : la structure que les appelants analysent déjà sous chaque clé de métrique reste inchangée.

Paramètres de requête

string
requis
Date de début (YYYY-MM-DD), incluse.
string
requis
Date de fin (YYYY-MM-DD), incluse.
string
requis
Types de métrique séparés par des virgules, par ex. qr,device,geography. Valeurs courantes : count, qr, date, day, time, utm, device, os, browser, handset, geography, geo_location, age. Nécessite le quota QR_ANALYTICS_ADVANCED du compte pour toute métrique autre que count.
string
défaut:"date"
Regroupement pour les types de métrique en série temporelle, par ex. date, week, month.
boolean
défaut:"false"
Exclut des résultats les scans identifiés comme du trafic de bots.
boolean
Passez true pour les appels de type vue d’ensemble du tableau de bord — contourne la limite de volume QR codes/plage de dates décrite ci-dessous, et ne compte pas dans le signal d’activité « analyses récupérées » du compte.

Corps de la requête

array
requis
Liste d’identifiants pour délimiter les analyses — le type d’identifiant dépend de filter_by.
string
défaut:"qrid"
L’un de qrid (identifiants de QR codes), id (identifiants numériques internes), tags (noms de tags) ou folder (identifiants de dossiers).

Réponse

La réponse est un objet indexé par chaque type de métrique demandé, plus qr_meta le cas échéant (voir ci-dessus). La structure varie selon le type de métrique — count renvoie des totaux de scans, device/os/browser/geography renvoient des répartitions selon cette dimension, et les types en série temporelle (date/day/time) renvoient une série regroupée selon group.
Demander trop de QR codes sur une plage de dates trop large renvoie une erreur 400 sous q : « High Volume of data. Either select lower than QR Codes/ days time period or generate Analytics Export instead. » En pratique, Exporter les analyses et Exporter les analyses brutes appliquent tous deux exactement la même limite — les trois endpoints partagent le même chemin de code de validation des requêtes — donc la véritable solution à cette erreur est de réduire q ou la plage de dates, et non de changer d’endpoint.

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: 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.

Paramètres de requête

from
string<date>
requis
to
string<date>
requis
type
string
requis

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

group
string
défaut:date

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

exclude_bot_scan
boolean
défaut:false
overview
boolean

Bypasses the volume cap; used by dashboard overview widgets.

Corps

application/json
q
string[]
requis

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

filter_by
enum<string>
défaut:qrid
Options disponibles:
qrid,
tags,
id,
folder

Réponse

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.