Skip to main content
POST
品牌列表查询用于获取当前 API Key 所属账号下的品牌资产列表。不传 brandId 时返回全部品牌,传入 brandId 时返回该品牌的明细。接口固定返回全量列表(不分页),按创建时间倒序排列。 返回的 id 是后续接口的关联主键,多数业务接口都需要先通过本接口拿到 brandId 再发起调用。
执行模式:SYNC · 实时请求。 请求发出后服务端同步执行业务,结果直接在当前响应的 data 中返回,不存在异步任务、无需轮询、无需二次查询。
注意与 AIBase 开发者文档的同名 geo.brand 区分。 AIBase 开发者文档 → GEO 品牌得分检测 中的 geo.brand 是品牌得分检测(ASYNC · 异步,入口 /v1/openapi/tasks);本页的 geo.brand 是品牌列表查询(SYNC · 实时,入口 /v1/openapi/execute)。两者 apiCode 同名,但入口、执行模式和返回结构完全不同,请勿混用。

接口速查

请求头

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

请求体

string
required
固定为 geo.brand。
object
业务请求参数,可为空对象 {};本接口所有业务参数均为可选。
string
品牌 ID。不传返回账号下全部品牌,传入则返回单个品牌明细。

返回参数

业务结果位于 data,为分页结构,其中 records 为品牌列表(本接口固定返回全量,size = -1)。
object[]
required
品牌明细列表。按创建时间倒序排列,可能为空数组。
string
required
品牌唯一标识,后续接口通过该 ID 关联。
string
required
品牌名称。
string
品牌描述文本。
string[]
产品 / 服务列表,可能为空数组。
string
目标用户群体描述。
string
品牌 Logo URL。
string
品牌官网 URL。
integer
required
监控状态:1 开启监控,0 关闭监控。
string
required
创建时间,格式 yyyy-MM-dd HH:mm:ss。
string
监控任务名称。
string
参与监控的 AI 平台,逗号分隔字符串,例如 deepseek,chatgpt。
string
最后监控日期,格式 yyyy-MM-dd,可能为 null。
string[]
品牌监控关键词列表,可能为空数组。
string
监控到期日,格式 yyyy-MM-dd,可能为 null。
integer
required
内部处理状态:0 正常,1 表示尚无查询数据。
integer
监控查询频率(天),可能为 null。
string
下次监控日期,格式 yyyy-MM-dd。停止监控时为 -,下次监控日晚于到期日时为 已过期。
integer
required
记录总数。
integer
required
每页条数。本接口固定返回全量,值为 -1。
integer
required
当前页码。
integer
required
总页数。

接入注意事项

  1. 固定业务标识:apiCode 必须填写 geo.brand。
  2. 凭证安全:AIBase-API-Key 属于敏感凭证,应仅在服务端使用,不要暴露到浏览器前端、移动端 App 或公开代码仓库。
  3. 参数全部可选:不传 brandId 即返回账号下全部品牌;data 也可整体传空对象 {}。
  4. 不分页:接口固定返回全量列表,size = -1,无需也无法传入分页参数。
  5. 排序固定:返回结果按创建时间倒序排列。
  6. 数组字段:productService、brandKeywords 为数组,请按数组解析,可能为空数组。
  7. 非日期文本:nextMonitorDate 可能出现 -、已过期 等非日期文本,不要强制按日期解析。
  8. 监控状态:monitorType = 1 表示开启监控,0 表示关闭。
  9. 空值兼容:解析时请对 data、records 做好 null / 空数组兼容。
完整响应类型可表示为 ReturnResult<PageResult<BrandData>>。
可按以上类型定义解析响应数据,完整响应类型为 ReturnResult<PageResult<BrandData>>。
本页的 cURL 与 Java 示例来自官方接口文档;Python 与 Node.js 示例为等价转写,未经服务端联调,请以实际返回结果为准。