Skip to main content
POST
导出原始的、按次扫描的分析记录——每条扫描事件对应一行,而不是 二维码分析导出分析数据 所返回的聚合细分数据。
这是一个仅支持 POST 的端点——GET 请求会返回 405 Method Not Allowedmanagement-api.json 规范此前将其列为 GET;此问题已被修正。
需要一个拥有 MANAGEMENT_API 配额的 Management API 密钥——参见 Management API 概览——外加账户的 EXPORT_ANALYTICS_REPORT 配额和 ANALYTICS_CAN_EXPORT_RAW 权限(这与聚合导出所需的 ANALYTICS_CAN_EXPORT 权限是不同的两项权限——一个角色可以拥有其中一项而没有另一项)。返回 403 并附带 "Your plan does not have export analytics report quota." 消息,说明该套餐不包含导出功能。

请求

此端点始终返回二进制文件,而非 JSON。

查询参数

string
必填
起始日期(YYYY-MM-DD),含当天。
string
必填
结束日期(YYYY-MM-DD),含当天。
string
必填
csvxlsxlsx。与 导出分析数据 不同,此处不支持 pdf 格式。任何其他值(或省略该参数)都会返回一个附带 "Invalid file format"400 错误。
string
传入 raw_bot 以仅导出被识别为机器人的扫描记录,而非全部扫描。传入其他任何值都会被覆盖——无论您在此传入什么,该端点始终导出原始数据。

请求体

二维码分析 的数据结构相同——q(必填)和 filter_by(默认 qrid)用于限定要包含哪些二维码的原始扫描数据,并且适用相同的二维码数量/日期范围数据量限制
array
必填
用于限定导出范围的标识符——具体类型取决于 filter_by
string
默认值:"qrid"
qrididtagsfolder 之一。

响应格式

返回一个单独的 CSV 文件(text/csvanalytics_raw.csv),包含原始扫描行数据。
如果账户启用了事件跟踪分析功能,并且 file_format 不是 csv,则会自动追加第二个工作表/区块,包含事件跟踪原始记录(会话 ID、时间戳、二维码 ID/名称、用户指定的事件跟踪 ID、URL 哈希值、URL)。请求 csv 时始终只返回扫描记录——该格式下会专门省略事件跟踪相关的行。

相关内容

授权

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>
必填
file_format
enum<string>
必填
可用选项:
csv,
xls,
xlsx
type
enum<string>

Pass raw_bot for a bot-only export; any other value is overwritten to raw.

可用选项:
raw_bot

请求体

application/json
q
string[]
必填
filter_by
enum<string>
默认值:qrid
可用选项:
qrid,
tags,
id,
folder

响应

Binary file download — text/csv for csv, spreadsheet mimetype for xls/xlsx.