Skip to Content
OpenAPI 接入团队、品牌与竞品管理

团队、品牌与竞品管理

获取团队下的所有品牌

  • 请求方法:POST
  • 请求路径:/geo/query/brand

请求参数:

入参类型含义是否必填
team_idstring团队ID是

响应参数:

返回值类型含义
idstring品牌ID
brand_namestring品牌名称

响应示例:

{ "code": 0, "msg": "success", "data": [ { "id": "brand_test_001", "brand_name": "测试品牌A" } ] }

新建品牌

  • 请求方法:POST
  • 请求路径:/geo/brand/create

请求参数:

入参类型含义是否必填
brandstring品牌名称是
aliasstring品牌别名否
team_idstring团队ID是
websitestring品牌官网否
descriptionstring品牌描述否
icon_mime_typestring品牌 logo 的 MIME 类型;支持 image/jpeg、image/jpg、image/png、image/gif、image/webp、image/svg+xml否
icon_datastring品牌 logo 内容,二进制字节流;最大 2MB否
notestring品牌备注否

响应参数:

返回值类型含义
idstring新建的品牌ID

响应示例:

{ "code": 0, "msg": "success", "data": { "id": "brand_test_001" } }

新建品牌(可同时初始化品牌基础信息、竞品、用户提问)

  • 请求方法:POST
  • 请求路径:/geo/brand/bundle/create

说明:

  • 当传入 team_id 时,表示在已有团队下新建品牌。
  • 当未传 team_id 且传入 team 时,表示先创建团队,再在该团队下创建品牌。
  • user_prompts 为品牌初始化时要创建的用户提问列表。

请求参数:

入参类型含义是否必填
team_idstring团队ID;已有团队下创建品牌时传入否
teamobject团队信息;未传 team_id 时需传入否
team.namestring团队名称条件必填
team.descriptionstring团队描述否
team.icon_mime_typestring团队 logo 的 MIME 类型;支持 image/jpeg、image/jpg、image/png、image/gif、image/webp、image/svg+xml否
team.icon_datastring团队 logo 内容,二进制字节流;最大 2MB否
brandobject品牌信息是
brand.brand_namestring品牌名称是
brand.aliasstring品牌别名否
brand.websitestring品牌官网否
brand.descriptionstring品牌描述否
brand.notestring品牌备注否
brand.icon_mime_typestring品牌 logo 的 MIME 类型;支持 image/jpeg、image/jpg、image/png、image/gif、image/webp、image/svg+xml否
brand.icon_datastring品牌 logo 内容,二进制字节流;最大 2MB否
user_promptsobject 数组初始化创建的用户提问列表是
user_prompts.questionstring用户提问内容是
competitorsobject 数组竞品列表否
competitors.namestring竞品名称否
competitors.aliasstring竞品别名否
competitors.descriptionstring竞品描述否
competitors.websitestring竞品官网否

响应参数:

返回值类型含义
brandobject新建后的品牌信息
brand.idstring品牌ID
brand.brand_namestring品牌名称
brand.aliasstring品牌别名
brand.websitestring品牌官网
brand.descriptionstring品牌描述
brand.notestring品牌备注
promptsobject 数组初始化创建的用户提问列表
prompts.prompt_idstring用户提问ID
prompts.questionstring用户提问内容
competitorsobject 数组新建后的竞品列表
competitors.competitor_idstring竞品ID
competitors.namestring竞品名称
competitors.aliasstring竞品别名
competitors.descriptionstring竞品描述
competitors.websitestring竞品官网
teamobject团队信息
team.team_idstring团队ID
team.namestring团队名称
team.descriptionstring团队描述

响应示例:

{ "code": 0, "msg": "success", "data": { "brand": { "id": "brand_test_001", "brand_name": "测试品牌A", "alias": "品牌A", "website": "https://brand-a.example.com", "description": "这是一个用于接口演示的测试品牌", "note": "测试备注" }, "prompts": [ { "prompt_id": "prompt_test_001", "question": "测试品牌A适合哪些业务场景?" } ], "competitors": [ { "competitor_id": "competitor_test_001", "name": "测试竞品A", "alias": "竞品A", "description": "这是一个用于接口演示的测试竞品", "website": "https://competitor-a.example.com" } ], "team": { "team_id": "team_test_001", "name": "测试团队A", "description": "用于接口演示的测试团队" } } }

编辑品牌基础信息

  • 请求方法:POST
  • 请求路径:/geo/brand/update

说明:更新时请一并传入全部可编辑字段,未传字段可能被置空。

请求参数:

入参类型含义是否必填
idstring品牌ID是
brand_namestring品牌名称是
brand_aliasstring品牌别名是
websitestring品牌官网是
descriptionstring品牌描述是
notestring品牌备注是
website_auto_tracebool是否自动追踪官网内容:true-开启,false-关闭是

响应参数:

接口调用成功时,返回空对象。

响应示例:

{ "code": 0, "msg": "success", "data": {} }
  • 请求方法:POST
  • 请求路径:/geo/brand/update/icon

请求参数:

入参类型含义是否必填
brand_idstring品牌ID是
mime_typestring图片 MIME 类型;支持 image/jpeg、image/jpg、image/png、image/gif、image/webp、image/svg+xml是
datastring图片内容,二进制字节流;最大 2MB是

响应参数:

返回值类型含义
icon_urlstring更新后的品牌 logo 地址

响应示例:

{ "code": 0, "msg": "success", "data": { "icon_url": "https://static.example.com/brand/logo-test.png" } }

获取竞品列表

  • 请求方法:POST
  • 请求路径:/geo/competitor/get

请求参数:

入参类型含义是否必填
brand_idstring品牌ID是

响应参数:

返回值类型含义
competitor_idstring竞品ID
competitor_namestring竞品名称
competitor_aliasstring竞品别名

响应示例:

{ "code": 0, "msg": "success", "data": [ { "competitor_id": "competitor_test_001", "competitor_name": "测试竞品A", "competitor_alias": "竞品A" } ] }

新建竞品

  • 请求方法:POST
  • 请求路径:/geo/competitor/create

请求参数:

入参类型含义是否必填
brand_idstring品牌ID是
competitor_namestring竞品名称是
competitor_aliasstring竞品别名否

响应参数:

返回值类型含义
idstring新建的竞品ID

响应示例:

{ "code": 0, "msg": "success", "data": { "id": "competitor_test_001" } }

编辑竞品

  • 请求方法:POST
  • 请求路径:/geo/competitor/update

说明:更新时请一并传入全部可编辑字段,未传字段可能被置空。

请求参数:

入参类型含义是否必填
brand_idstring品牌ID是
competitor_idstring竞品ID是
competitor_namestring竞品名称是
competitor_aliasstring竞品别名是

响应参数:

接口调用成功时,返回空对象。

响应示例:

{ "code": 0, "msg": "success", "data": {} }

删除竞品

  • 请求方法:POST
  • 请求路径:/geo/competitor/delete

请求参数:

入参类型含义是否必填
brand_idstring品牌ID是
competitor_idstring竞品ID是

响应参数:

接口调用成功时,返回空对象。

响应示例:

{ "code": 0, "msg": "success", "data": {} }

分页查询团队操作日志

  • 请求方法:POST
  • 请求路径:/geo/team/logs

请求参数:

入参类型含义是否必填
team_idstring团队 ID是
pageint默认 1否
page_sizeint默认 20;超过 100 时按 100 处理否
actionsstring 数组操作类型;空数组或省略表示不过滤否
operator_uidsstring 数组操作者 UID;空数组或省略表示不过滤否

请求示例:

{ "team_id": "2001", "page": 1, "page_size": 20, "actions": [ "set_member_role" ], "operator_uids": [ "4002" ] }

响应参数:

返回值类型含义
codeint0 表示成功
msgstring返回消息
data.logsobject 数组日志列表
data.logs[].log_id / team_idstring日志 ID / 团队 ID
data.logs[].created_bystring操作者展示名,不是 UID
data.logs[].contentstring操作描述
data.logs[].created_atstring内网为 YYYY-MM-DD;海外为 UTC RFC 3339 时间
data.totalint符合条件的总数

响应示例:

{ "code": 0, "msg": "success", "data": { "logs": [ { "log_id": "8001", "created_by": "测试管理员A", "team_id": "2001", "content": "测试管理员A将测试成员A设为成员", "created_at": "2026-10-14" } ], "total": 1 } }
Answerbit - AI搜索可见度追踪平台