Skip to main content
POST
返回一个或多个二维码的聚合扫描分析数据,按您请求的一个或多个指标类型进行分组。
尽管名称听起来像是一次查询,这实际上是一个仅支持 POST 的端点——GET 请求会返回 405 Method Not Allowed。查询参数(fromtotype)用于选择日期范围和指标;请求体则用于选择要包含哪些二维码。
需要一个拥有 MANAGEMENT_API(或 MANAGEMENT_API_SANDBOX)配额的 Management API 密钥——参见 Management API 概览——以及账户自身的 QR_ANALYTICS_BASIC 配额。请求 count 指标以外的任何内容还需要 QR_ANALYTICS_ADVANCED;若没有该配额,无论您请求的 type 是什么,请求都会被静默降级为 count

请求

已通过线上环境核实——此处空的 qr 数组反映的是该二维码在请求的时间窗口内扫描次数为零,而不是发生了错误。qr_meta 是一个额外的 name -> {qrid, category, category_slug} 映射,仅当 qr 出现在请求的 type 中时才会添加,方便调用方从以名称为键的行反查回其 qrid。它是增量式的:调用方已经在解析的各指标键下的数据结构保持不变。

查询参数

string
必填
起始日期(YYYY-MM-DD),含当天。
string
必填
结束日期(YYYY-MM-DD),含当天。
string
必填
以逗号分隔的指标类型,例如 qr,device,geography。常见取值:countqrdatedaytimeutmdeviceosbrowserhandsetgeographygeo_locationage。请求 count 以外的任何内容都需要账户的 QR_ANALYTICS_ADVANCED 配额。
string
默认值:"date"
时间序列型指标类型的分组方式,例如 dateweekmonth
boolean
默认值:"false"
从结果中排除被识别为机器人流量的扫描。
boolean
传入 true 以用于仪表盘概览风格的调用——绕过下文所述的二维码数量/日期范围数据量限制,且不计入账户的”已获取分析数据”活跃度信号。

请求体

array
必填
用于限定分析范围的标识符列表——标识符的类型取决于 filter_by
string
默认值:"qrid"
qrid(二维码 ID)、id(内部数字 ID)、tags(标签名称)或 folder(文件夹 ID)之一。

响应

响应是一个以每个请求的指标 type 为键的对象,如适用还会包含 qr_meta(见上文)。数据结构因指标类型而异——count 返回扫描总数,device/os/browser/geography 返回按该维度的细分数据,而时间序列类型(date/day/time)则返回按 group 分桶的序列数据。
请求过多二维码或过宽的日期范围,会在 q 字段下返回一个 400 错误:"High Volume of data. Either select lower than {N} QR Codes/{N} days time period or generate Analytics Export instead." 实际上,导出分析数据导出原始分析数据都强制执行完全相同的限制——三个端点共享同一套请求校验代码路径——因此这个错误的真正解决办法是缩小 q 或日期范围,而不是切换端点。

相关内容

授权

Authorization
string
header
必填

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.

查询参数

from
string<date>
必填
to
string<date>
必填
type
string
必填

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

group
string
默认值:date

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

exclude_bot_scan
boolean
默认值:false
overview
boolean

Bypasses the volume cap; used by dashboard overview widgets.

请求体

application/json
q
string[]
必填

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

filter_by
enum<string>
默认值:qrid
可用选项:
qrid,
tags,
id,
folder

响应

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.