Skip to main content
POST
查询指定品牌下的竞争对手列表。可通过 competitorName 按名称模糊筛选,不传则返回该品牌全部竞品。接口固定返回全量列表,按创建时间倒序排列。
执行模式:SYNC · 实时请求。 请求发出后服务端同步执行业务,结果直接在当前响应的 data 中返回,不存在异步任务、无需轮询、无需二次查询。

接口速查

请求头

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

请求体

string
required
固定为 geo.competitors
string
required
所属品牌 ID,为空返回 4001
string
竞品名称关键字,按名称模糊筛选;不传返回全部竞品

返回参数

业务结果位于 data,为分页结构,其中 records 为竞品列表(本接口固定返回全量,size = -1)。
object[]
竞品明细列表。
string
竞品唯一标识。
string
竞品名称。
string
竞品 Logo URL。
integer
1 开启监控,0 关闭监控。
string
竞品官网 URL。
object
竞品监控关键词,JSON 数组解析后的数组,可能为 null。
string
格式 yyyy-MM-dd HH:mm:ss。
long / integer
总数、每页条数、当前页、总页数;本接口返回全量,size = -1。
long / integer
同上,见上方分页字段说明。
long / integer
同上,见上方分页字段说明。
long / integer
同上,见上方分页字段说明。

接入注意事项

  1. apiCode 必须固定为 geo.competitors。
  2. brandId 为必填参数,为空返回 4001(所需参数不足)。
  3. competitorName 可选,按名称模糊筛选。
  4. 接口固定返回全量列表,size = -1,无需传分页参数。
  5. competitorKeywords 可能为 null,解析时做好空值兼容。
  6. 建议先通过 geo.brand 获取品牌 ID,再调用本接口。
完整响应类型可表示为 ReturnResult<PageResult<CompetitorData>>(PageResult 定义见 6.2.5)。
可按以下 TypeScript 类型定义解析响应数据。
本页的 cURL 与 Java 示例来自官方接口文档;Python 与 Node.js 示例为等价转写,未经服务端联调,请以实际返回结果为准。