Skip to main content
POST
查询指定品牌在指定时间范围内的品牌提及情况,返回品牌相关 URL 总数及其在官网、仅提及品牌、品牌与竞品共同提及三类构成下的数量与占比。
执行模式:SYNC · 实时请求。 请求发出后服务端同步执行业务,结果直接在当前响应的 data 中返回,不存在异步任务、无需轮询、无需二次查询。

接口速查

请求头

string
required
开发者 API Key,例如 AIBase_xxx。用于身份认证、有效期与调用权限校验,请仅在服务端保存和使用。
string
required
固定为 application/json。
string
开发者自定义请求 ID,用于请求追踪;不传时系统自动生成 UUID。

请求体

string
required
固定为 source.brand.citation.overview。
object
required
业务请求参数对象。
string
required
品牌 ID。所属品牌 ID,为空返回 4001
string
AI平台。按 AI 平台筛选,如 deepseek;不传返回全部平台
string
开始日期。格式 yyyy-MM-dd;默认最近 7 天
string
结束日期。格式 yyyy-MM-dd;默认今天,不能晚于今天
时间范围规则:startDate/endDate 不传时默认查询最近 7 天;endDate 晚于今天会被自动截断为今天;起止时间跨度最大 6 个月;开始日期晚于结束日期将直接报错。

返回参数

业务结果位于 data,为单个汇总对象,返回品牌相关 URL 的提及构成与占比。聚合查询恒返回一条记录;无数据时 brandTotalCount 为 0,各占比字段可能为 null。
integer
品牌相关 URL 总数。与品牌相关的 URL 总数。
integer
官网 URL 数量。品牌官网相关的 URL 数量。
number
官网占比。官网 URL 占品牌相关 URL 总数的比例(%)。
integer
仅提及品牌 URL 数量。仅提及本品牌、未涉及竞品的 URL 数量。
number
仅提及品牌占比。仅提及品牌 URL 占比(%)。
integer
品牌与竞品共同提及 URL 数量。同时提及本品牌与竞品的 URL 数量。
number
品牌与竞品共同提及占比。共同提及 URL 占比(%)。

接入注意事项

  1. apiCode 必须固定为 source.brand.citation.overview。
  2. brandId 为必填参数,为空返回 4001(所需参数不足)。
  3. startDate/endDate 格式必须为 yyyy-MM-dd,默认最近 7 天,最大查询跨度 6 个月。
  4. 返回为单个汇总对象;无数据时 brandTotalCount 为 0,各占比字段可能为 null。
  5. 各占比字段均以 brandTotalCount 为分母,分母为 0 时占比为 null。
完整响应类型可表示为 ReturnResult<BrandCitationOverview>(ReturnResult 定义见 6.2.5)。
可按以上 TypeScript 类型定义解析响应数据。
本页的 cURL 与 Java 示例来自官方接口文档;Python 与 Node.js 示例为等价转写,未经服务端联调,请以实际返回结果为准。