Skip to Content
OpenAPI 接入

Open API 接入列表

接入

  1. 通过 AnswerBit 服务人员申请 Open API Key。
  2. 在 HTTP Header 中携带 X-API-Key

Header 举例:

X-API-Key: xxxxxxx
  • 外网用户:base_url: https://answerbit.qq.com
  1. TeamIDBrandID 由 AnswerBit 服务人员提供,也可从控制台页面 URL 中获取。 TeamId 和 BrandID 的来源
  2. Key 的可访问团队、品牌及读写能力以申请时开通的权限为准。

团队、品牌与竞品管理

获取团队下的所有品牌

  • 请求方法: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/jpegimage/jpgimage/pngimage/gifimage/webpimage/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/jpegimage/jpgimage/pngimage/gifimage/webpimage/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/jpegimage/jpgimage/pngimage/gifimage/webpimage/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/jpegimage/jpgimage/pngimage/gifimage/webpimage/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/article/tag/get

请求参数

入参类型含义是否必填
team_idstring团队ID
tag_typeint标签类型:1-用户标签,2-系统标签

响应参数

返回值类型含义
tag_idstring标签ID
team_idstring团队ID
namestring标签名称
notestring标签备注
tag_typeint标签类型:1-用户标签,2-系统标签
statusint标签状态:1-启用,2-禁用
created_bystring创建人
article_countint标签关联的文章数
created_timeint64创建时间

响应示例:

{ "code": 0, "msg": "success", "data": [ { "tag_id": "tag_test_001", "team_id": "team_test_001", "name": "测试标签A", "note": "测试标签备注", "tag_type": 1, "status": 1, "created_by": "test_user", "article_count": 10, "created_time": "1735689600000" } ] }

新建文章并加入追踪

  • 请求方法:POST
  • 请求路径:/geo/article/trace/save

请求参数

入参类型含义是否必填
brand_idstring品牌ID
titlestring文章标题
urlsstring 数组文章的各个发布链接
tag_idsstring 数组文章需要关联的标签ID
languagestring文章语言,使用 BCP 47 语言码;默认 zh-CN。支持:zh-CNzh-SGzh-TWzh-HKzh-MOen-USen-GBja-JPko-KRfr-FRde-DEes-ESpt-BRpt-PTit-ITth-THvi-VNid-IDar-SAru-RUms-MY

返回参数

返回值类型含义
article_idstring文章ID

响应示例:

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

获取文章列表

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

说明:

  • 该接口用于获取品牌下的文章列表,并返回文章维度的汇总引用数据。
  • 如果只需要导出文章维度的引用总数、引用趋势、已发布平台等信息,该接口可以直接满足。
  • 如果需要按 AI 平台拆分的引用明细,需要先通过该接口获取 article_id,再调用「获取文章追踪详情」。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
limitint每次返回数量;不传默认 20
scroll_idstring游标;翻页时传上一次响应中的 scroll_id
start_timeint64引用统计开始时间,毫秒时间戳
end_timeint64引用统计结束时间,毫秒时间戳
titlestring文章标题关键字
statusint 数组文章状态列表
sourceint 数组文章来源列表
template_typeint 数组文章模板类型列表
tag_idsstring 数组标签ID列表
ref_order_typeint引用数排序:1-升序,2-降序
languagestring 数组文章语言列表,使用 BCP 47 语言码
has_videobool是否筛选已生成视频的文章
has_video_generatingbool是否筛选视频生成中的文章

响应参数

返回值类型含义
listobject 数组文章列表
list.idstring文章ID
list.brand_idstring品牌ID
list.titlestring文章标题
list.statusint文章状态
list.sourceint文章来源
list.template_typeint文章模板类型
list.ref_countint当前筛选时间范围内的文章引用总数
list.fluctuationfloat引用数变化值
list.ref_trendsobject 数组文章引用趋势
list.ref_trends.datestring日期,格式:YYYY-MM-DD
list.ref_trends.countint当日引用数
list.published_platformsobject 数组文章已发布平台
list.published_platforms.platformstring发布平台标识
list.published_platforms.display_namestring发布平台展示名
list.published_platforms.icon_urlstring发布平台图标
list.published_platforms.publish_urlstring发布链接
scroll_idstring下一页游标;为空表示没有更多数据
totalint匹配文章总数
total_linksint匹配文章的发布链接总数

响应示例:

{ "code": 0, "msg": "success", "data": { "list": [ { "id": "article_test_001", "brand_id": "brand_test_001", "title": "测试文章A", "status": 1, "source": 1, "template_type": 1, "ref_count": 12, "fluctuation": 3, "ref_trends": [ { "date": "2026-01-15", "count": 4 } ], "published_platforms": [ { "platform": "wechat", "display_name": "微信公众号", "icon_url": "https://static.example.com/platform/wechat.png", "publish_url": "https://example.com/article/a" } ] } ], "scroll_id": "12:article_test_001", "total": 1, "total_links": 1 } }

获取文章追踪详情

  • 请求方法:POST
  • 请求路径:/geo/article/trace/detail

说明:

  • 该接口用于获取单篇追踪文章的引用详情,包含按 AI 平台拆分的引用次数和趋势。

请求参数

入参类型含义是否必填
article_idstring文章ID
begin_datestring开始日期,格式:YYYY-MM-DD;不传则按系统默认统计范围
end_datestring结束日期,格式:YYYY-MM-DD;传入时需与 begin_date 同时传入

响应参数

返回值类型含义
trace_infoobject 数组文章追踪记录列表;一篇文章可对应多个发布链接
trace_info.trace_idstring追踪记录ID
trace_info.article_idstring文章ID
trace_info.urlstring追踪链接
trace_info.platformstring发布平台
trace_info.iconstring发布平台图标
trace_info.titlestring文章标题
trace_info.can_editbool当前追踪链接是否允许编辑
trace_info.statsobject当前追踪链接的引用统计
statsobject文章整体引用统计
stats.ref_countobject按 AI 平台统计的引用次数,key 为平台标识,value 为引用次数
stats.total_countint引用总数
stats.ref_count_increaseint引用增长数
stats.ref_trendsobject 数组按 AI 平台拆分的引用趋势
stats.ref_trends.platformstringAI 平台标识
stats.ref_trends.ref_trendsobject 数组该平台下的每日引用趋势
stats.ref_trends.ref_trends.datestring日期,格式:YYYY-MM-DD
stats.ref_trends.ref_trends.ref_countint当日引用数
stats.ref_trends.ref_trends.promptsobject 数组产生引用的用户提问列表
stats.ref_trends.ref_trends.prompts.prompt_idstring用户提问ID
stats.ref_trends.ref_trends.prompts.prompt_contentstring用户提问内容
stats.ref_trends.ref_trends.prompts.title_namestring用户提问分类名称
stats.ref_trends.ref_trends.prompts.ref_countint该用户提问产生的引用数

响应示例:

{ "code": 0, "msg": "success", "data": { "trace_info": [ { "trace_id": "trace_test_001", "article_id": "article_test_001", "url": "https://example.com/article/a", "platform": "wechat", "icon": "https://static.example.com/platform/wechat.png", "title": "测试文章A", "can_edit": false, "stats": { "ref_count": { "deepseek": 4, "yuanbao": 2 }, "total_count": 6 } } ], "stats": { "ref_count": { "deepseek": 8, "yuanbao": 4 }, "total_count": 12, "ref_count_increase": 3, "ref_trends": [ { "platform": "deepseek", "ref_trends": [ { "date": "2026-01-15", "ref_count": 4, "prompts": [ { "prompt_id": "prompt_test_001", "prompt_content": "测试品牌A适合哪些业务场景?", "title_name": "测试分类A", "ref_count": 2 } ] } ] } ] } } }

用户提问与分类管理

新建用户提问

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

请求参数

入参类型含义是否必填
brand_idstring品牌ID
title_idstring用户提问分类ID
query_strstring用户提问内容
recommend_idstring关联推荐记录ID

响应参数

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

响应示例:

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

更新用户提问

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

说明:该接口为局部更新(patch)语义。idbrand_id 必传;query_strstatus 按传入内容更新,未传则不更新。注意:query_str 不能更新为空字符串,status=0 不表示更新。

请求参数

入参类型含义是否必填
idstringquery ID
brand_idstring品牌ID
query_strstring用户提问内容;传入时更新
statusint用户提问状态;传入时更新,支持:1-启用,2-禁用。0 不表示有效状态,仅表示不更新

响应参数

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

响应示例:

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

批量新建用户提问

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

请求参数

入参类型含义是否必填
brand_idstring品牌ID
title_idstring用户提问分类ID
promptsstring 数组用户提问内容列表
recommend_idsstring 数组关联推荐记录ID列表,与 prompts 一一对应;无关联时可填 -1

响应参数

返回值类型含义
prompt_idsstring 数组新建的用户提问ID 列表

响应示例:

{ "code": 0, "msg": "success", "data": { "prompt_ids": [ "prompt_test_001", "prompt_test_002" ] } }

获取品牌下的用户提问列表(分组)

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

说明:

  • 该接口用于获取品牌下的用户提问列表,按用户提问分类分组。
  • 不传 begin_dateend_date 时,默认查询最近 7 天;只传其中一个会返回参数错误。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
group_typeint分组类型:1-按用户提问分类
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
pageint页码
page_sizeint每页数量
title_idsstring 数组用户提问分类ID列表
tag_idsstring 数组标签ID列表
query_strstring用户提问关键字

响应参数

返回值类型含义
titlesobject 数组按分类分组的结果
titles.title_idstring分类ID
titles.title_namestring分类名称
titles.title_descstring分类描述
titles.prompt_countint分类下的用户提问数量
titles.exposurefloat曝光率
titles.fluctuationfloat曝光率变化值
titles.avg_rankfloat平均排名
titles.daily_avg_scoreobject 数组每日平均分
titles.promptsobject 数组分类下的用户提问列表
prompts.idstring用户提问ID
prompts.query_strstring用户提问内容
prompts.statusint用户提问状态:1-启用,2-禁用
prompts.exposurefloat曝光率
prompts.avg_rankfloat平均排名
prompts.daily_avg_scoreobject 数组每日平均分
prompts.title_idstring分类ID
prompts.title_namestring分类名称
prompts.creator_namestring创建人名称
prompts.created_timeint64创建时间
prompts.fluctuationfloat曝光率变化值
prompts.trace_article_cntint关联追踪文章数量
prompts.tagsobject 数组用户提问关联标签
totalint分组总数
total_promptsint用户提问总数

响应示例:

{ "code": 0, "msg": "success", "data": { "titles": [ { "title_id": "title_test_001", "title_name": "测试分类A", "title_desc": "用于演示的用户提问分类", "prompt_count": 1, "exposure": 0.8, "fluctuation": 0.1, "avg_rank": 2.5, "daily_avg_score": [ { "date": "2026-01-15", "score": 86 } ], "prompts": [ { "id": "prompt_test_001", "query_str": "测试品牌A适合哪些业务场景?", "status": 1, "exposure": 0.8, "avg_rank": 2.5, "title_id": "title_test_001", "title_name": "测试分类A", "creator_name": "test_user", "created_time": "1735689600000", "trace_article_cnt": 3 } ] } ], "total": 1, "total_prompts": 1 } }

获取用户提问分类列表

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

说明:这里的“分类”对应系统中的 title

请求参数

入参类型含义是否必填
brand_idstring品牌ID
idstring分类ID
title_namestring分类名称,支持按名称过滤

响应参数

返回值类型含义
idstring分类ID
brand_idstring品牌ID
title_namestring分类名称
title_descstring分类描述
countint该分类下的用户提问数量
created_timestring创建时间
updated_timestring更新时间

响应示例:

{ "code": 0, "msg": "success", "data": [ { "id": "title_test_001", "brand_id": "brand_test_001", "title_name": "测试分类A", "title_desc": "用于演示的用户提问分类", "count": 12, "created_time": "2026-01-01", "updated_time": "2026-01-15" } ] }

新建用户提问 分类

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

说明:这里的“分类”对应系统中的 title

请求参数

入参类型含义是否必填
brand_idstring品牌ID
title_namestring分类名称
title_descstring分类描述

响应参数

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

响应示例:

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

更新用户提问 分类

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

说明:这里的“分类”对应系统中的 title。该接口为部分更新语义:idbrand_idtitle_name 必传;title_desc 传入时才更新,未传则不更新。

请求参数

入参类型含义是否必填
idstring分类ID
brand_idstring品牌ID
title_namestring分类名称
title_descstring分类描述;传入时更新

响应参数

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

响应示例:

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

更新用户提问 所属分类

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

说明:该接口不是局部更新,而是替换关联语义,用于将指定用户提问重新归类到新的分类下。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
title_idstring目标分类ID
prompt_idstring用户提问ID

响应参数

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

响应示例:

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

删除用户提问

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

请求参数

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

响应参数

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

响应示例:

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

批量删除用户提问

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

请求参数

入参类型含义是否必填
prompt_idsstring 数组用户提问ID 列表
brand_idstring品牌ID

响应参数

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

响应示例:

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

删除用户提问分类

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

请求参数

入参类型含义是否必填
idstring分类ID

响应参数

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

响应示例:

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

大模型回答

获取大模型回答记录列表

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

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
includeint提示词筛选方式:0-不包含,1-包含
promptstring用户提问关键字
title_idstring 数组提示词标题ID列表
prompt_idsstring 数组提示词ID列表
tag_idsstring 数组标签ID列表
task_idsstring 数组任务ID列表
platformsstring 数组大模型平台列表
languagestring 数组语言列表
mention_brandint是否提及品牌筛选:-1-全部,0-未提及,1-提及
min_scoreint最小分数
max_scoreint最大分数
urlstring引用链接URL过滤
ref_platformstring引用来源域名过滤(兼容旧参数)
article_idstring文章ID过滤
pageint页码
page_sizeint每页数量

响应参数

返回值类型含义
scoresobject 数组大模型回答记录列表
scores.task_idstring任务ID
scores.query_idstring提示词ID
scores.query_strstring提示词内容
scores.platformstring大模型平台
scores.languagestring语言
scores.zonestring地区
scores.datestring任务日期
scores.exposureint是否提及品牌:0-未提及,1-提及
scores.scoreint品牌曝光度评分
scores.avg_rankint品牌排名,0 表示未提及
scores.title_idstring提示词标题ID
scores.title_namestring提示词标题名称
scores.trace_article_cntint追踪文章引用数量
scores.tagsobject 数组提示词关联标签
scores.tags.tag_idstring标签ID
scores.tags.tag_namestring标签名称
scores.tags.tag_typeint标签类型:1-用户,2-系统,3-大模型
totalint总数

响应示例:

{ "code": 0, "msg": "success", "data": { "scores": [ { "task_id": "task_test_001", "prompt_id": "prompt_test_001", "query_str": "测试品牌A适合哪些业务场景?", "platform": "test-llm", "language": "zh", "zone": "CN", "date": "2026-01-15", "exposure": 1, "score": 86, "avg_rank": 2, "title_id": "title_test_001", "title_name": "测试分类A", "trace_article_cnt": 3, "tags": [ { "tag_id": "tag_test_001", "tag_name": "测试标签A", "tag_type": 1 } ] } ], "total": 1 } }

获取大模型回答记录详情

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

请求参数

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

响应参数

返回值类型含义
querystring提示词内容
query_idstring提示词ID
scoreint品牌曝光度评分
zonestring地区
languagestring语言
exposureint是否提及品牌:0-未提及,1-提及
rankint品牌排名,0 表示未提及
exposure_cntint品牌提及次数
llm_outputstring大模型回答原文
platformstring大模型平台
datestring任务日期
linksobject 数组引用链接列表
links.indexint引用序号
links.urlstring引用链接URL
links.titlestring引用链接标题
links.sourceint引用来源类型:0-未关联追踪文章/未知,1-平台创作,2-用户创作,3-官网文章
links.article_idstring关联追踪文章ID
picstring 数组图片链接列表
fanoutobject 数组扩展信息列表
recommend_queriesstring 数组推荐提示词列表
video_cardsobject 数组视频卡片列表
video_cards.idstring视频卡片ID
video_cards.video_titlestring视频标题
video_cards.source_namestring来源名称
video_cards.video_descriptionstring视频描述
video_cards.video_linkstring视频链接
video_cards.sort_indexint排序序号
video_cards.cover_urlstring封面图链接
product_cardsobject 数组商品卡片列表
product_cards.idstring商品卡片ID
product_cards.product_namestring商品名称
product_cards.product_pricestring商品价格
product_cards.product_imagestring商品图片
product_cards.product_linkstring商品链接
product_cards.product_descriptionstring商品描述
product_cards.platformstring商品平台
product_cards.sort_indexint排序序号
title_namestring提示词标题名称
title_idstring提示词标题ID
tagsobject 数组提示词关联标签
tags.tag_idstring标签ID
tags.tag_namestring标签名称
tags.tag_typeint标签类型:1-用户,2-系统,3-大模型

响应示例:

{ "code": 0, "msg": "success", "data": { "prompt": "测试品牌A适合哪些业务场景?", "prompt_id": "prompt_test_001", "score": 86, "zone": "CN", "language": "zh", "exposure": 1, "rank": 2, "exposure_cnt": 1, "llm_output": "测试品牌A适用于场景一、场景二与场景三。", "platform": "test-llm", "date": "2026-01-15", "links": [ { "index": 1, "url": "https://example.com/articles/test-article-1", "title": "测试文章一", "source": 1, "article_id": "article_test_001" } ], "pic": [ "https://example.com/images/test-image-1.png" ], "fanout": [], "recommend_queries": [ "测试品牌A的核心优势是什么?" ], "video_cards": [ { "id": "video_card_test_001", "video_title": "测试视频一", "source_name": "测试来源", "video_description": "测试视频描述", "video_link": "https://example.com/videos/test-video-1", "sort_index": 1, "cover_url": "https://example.com/images/video-cover-1.png" } ], "product_cards": [ { "id": "product_card_test_001", "product_name": "测试商品一", "product_price": "99.00", "product_image": "https://example.com/images/product-1.png", "product_link": "https://example.com/products/test-product-1", "product_description": "测试商品描述", "platform": "test-platform", "sort_index": 1 } ], "title_name": "测试分类A", "title_id": "title_test_001", "tags": [ { "tag_id": "tag_test_001", "tag_name": "测试标签A", "tag_type": 1 } ] } }

AI 文章生成与外部发布

获取文章模板

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

说明:

  • 该接口用于获取当前可用的文章模板列表,建议在调用「生成文章」前使用。
  • template_id 即创建文章时的 template_type

请求参数

入参类型含义是否必填
local_codestring模板说明语言,使用 BCP 47 语言码;默认 zh-CN

响应参数

返回值类型含义
template_idint模板类型ID
template_namestring模板名称
descriptionstring模板描述
is_high_refint是否高引用模板:0-否,1-是。为 1 时,生成文章需传入 high_ref

响应示例:

{ "code": 0, "msg": "success", "data": [ { "template_id": 1, "template_name": "品牌介绍", "description": "适用于品牌与产品介绍", "is_high_ref": 0 } ] }

生成文章

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

说明:

  • 该接口用于提交文章生成任务。接口返回成功仅表示任务已受理,不表示正文已生成完成。
  • 如需在平台内持续追踪发布后的引用效果,可继续调用「新建文章并加入追踪」。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
template_typeint文章模板类型,可通过「获取文章模板」取得
prompt_idsstring 数组用户提问ID列表,最多 20 个
knowledge_idsstring 数组参考素材ID列表,最多 20 个
once_knowledgestring本次生成使用的补充资料
high_refobject高引用模板的参考文章;is_high_ref=1 时必填条件必填
high_ref.urlstring参考文章链接;填写后无需再传标题和正文
high_ref.titlestring参考文章标题;未传链接时需与正文同时传入
high_ref.contentstring参考文章正文;未传链接时需与标题同时传入
tag_idsstring 数组文章需要关联的标签ID
languagestring文章语言,使用 BCP 47 语言码;默认 zh-CN。支持:zh-CNzh-SGzh-TWzh-HKzh-MOen-USen-GBja-JPko-KRfr-FRde-DEes-ESpt-BRpt-PTit-ITth-THvi-VNid-IDar-SAru-RUms-MY

响应参数

返回值类型含义
idstring文章ID

响应示例:

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

获取文章内容

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

说明:

  • 该接口用于获取单篇文章的标题和正文。
  • status=0 表示仍在生成;status=1 表示已生成、待发布。生成完成后,titlemain_body 可供自行发布。

请求参数

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

响应参数

返回值类型含义
article_idstring文章ID
brand_idstring品牌ID
titlestring文章标题
main_bodystring文章正文
statusint文章状态:0-生成中,1-待发布,2-发布中,3-追踪中
template_typeint文章模板类型
sourceint文章来源:1-平台创作,2-用户创作
languagestring文章语言,使用 BCP 47 语言码
tagsobject 数组文章关联标签
tags.tag_idstring标签ID
tags.tag_namestring标签名称

响应示例:

{ "code": 0, "msg": "success", "data": { "article_id": "article_test_001", "brand_id": "brand_test_001", "title": "测试品牌A的核心能力与适用场景", "main_body": "这里是生成完成的文章正文。", "status": 1, "template_type": 1, "source": 1, "language": "zh-CN", "tags": [ { "tag_id": "tag_test_001", "tag_name": "产品介绍" } ] } }

计量中心

说明:

  • 以下接口对应控制台「计量中心」:订阅与额度、积分消耗、操作记录。
  • 品牌消耗详情页复用积分消耗与记录接口,传入 brand_id 即可按品牌查询。

用量类型 quota_type 说明:

quota_type含义
article_generateAI文章生成
article_publish辅助发文
content_tracking内容追踪
task_runAI回答采集
task_scoringAI回答分析
prompt_recommend用户提问智能推荐
video_generateAI视频生成
max_brand品牌数量
max_member团队成员数量
max_prompt用户提问数量
max_competitor竞品数量

实际返回的用量类型以当前套餐及已开通能力为准。

获取当前周期用量

  • 请求方法:POST
  • 请求路径:/geo/billing/report/usage

说明:

  • 该接口用于获取计量中心顶部的额度卡片:品牌、成员、提问、竞品等容量,以及当前周期用量。
  • 不传 brand_id 或传入 0 时查询团队范围;传入品牌ID时查询该品牌相关用量。

请求参数

入参类型含义是否必填
team_idstring团队ID
brand_idstring品牌ID;不传或传 0 表示团队范围

响应参数

返回值类型含义
planobject当前周期用量
plan.valid_fromint64当前周期开始时间,Unix秒时间戳
plan.valid_untilint64当前周期结束时间,Unix秒时间戳
plan.quotasobject 数组各类用量汇总
plan.quotas.quota_typestring用量类型
plan.quotas.total_amountint当前额度
plan.quotas.used_amountint当前已使用量
plan.quotas.reset_timeint64下次重置时间,Unix秒时间戳
creditobject积分概况
credit.team_idstring团队ID
credit.total_amountint当前可用积分
credit.used_amountint已确认消耗的积分

响应示例:

{ "code": 0, "msg": "success", "data": { "plan": { "valid_from": "1780243200", "valid_until": "1782835199", "quotas": [ { "quota_type": "article_generate", "total_amount": 800, "used_amount": 126, "reset_time": "1782835199" }, { "quota_type": "content_tracking", "total_amount": 500, "used_amount": 42, "reset_time": "1782835199" } ] }, "credit": { "team_id": "team_test_001", "total_amount": 13300, "used_amount": 1700 } } }

获取订阅信息

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

说明:

  • 该接口用于获取计量中心顶部的套餐名称、订阅状态、计费周期和到期时间。

请求参数

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

响应参数

返回值类型含义
plan_idstring套餐ID
plan_namestring套餐名称
tierstring套餐等级
statusint订阅状态:1-生效中,2-资源超限暂停,3-已过期,4-已取消
started_atint64订阅开始时间,Unix秒时间戳
expired_atint64订阅到期时间,Unix秒时间戳
billing_periodint计费周期:1-月付,2-年付
billing_amountint计费时长,配合 billing_period 使用
current_cycle_startint64当前计费周期开始时间,Unix秒时间戳
current_cycle_endint64当前计费周期结束时间,Unix秒时间戳
is_trialbool是否试用:true-是,false-否

响应示例:

{ "code": 0, "msg": "success", "data": { "plan_id": "plan_test_001", "plan_name": "专业版", "tier": "pro", "status": 1, "started_at": "1780243200", "expired_at": "1811779199", "billing_period": 1, "billing_amount": 1, "current_cycle_start": "1780243200", "current_cycle_end": "1782835199", "is_trial": false } }

获取积分状态

  • 请求方法:POST
  • 请求路径:/geo/billing/credit/status

说明:

  • 该接口用于获取计量中心积分卡的当前可用积分、已确认消耗及积分明细。
  • credit_details.status=5 的积分会出现在明细中,但不计入顶层 total_amount

请求参数

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

响应参数

返回值类型含义
team_idstring团队ID
total_amountint当前可用积分总量
used_amountint已确认消耗的积分
credit_detailsobject 数组积分明细
credit_details.credit_idstring积分记录ID
credit_details.source_typeint积分来源:1-套餐发放,2-充值,3-人工调整
credit_details.total_amountint该笔积分当前可用数量
credit_details.used_amountint该笔积分已确认消耗
credit_details.expire_timeint64过期时间,Unix秒时间戳
credit_details.statusint积分状态:1-可用,2-已用完,3-已过期,4-已关闭,5-冻结中

响应示例:

{ "code": 0, "msg": "success", "data": { "team_id": "team_test_001", "total_amount": 13290, "used_amount": 1710, "credit_details": [ { "credit_id": "credit_test_001", "source_type": 1, "total_amount": 10000, "used_amount": 1200, "expire_time": "1811779200", "status": 1 } ] } }

获取积分消耗占比

  • 请求方法:POST
  • 请求路径:/geo/billing/credit/usage

说明:

  • 该接口用于获取计量中心「积分消耗」中的类型占比。
  • 不传 start_unixend_unix 时,默认查询当前计费周期。
  • 不传 brand_id 或传入 0 时查询团队范围;传入品牌ID时查询该品牌相关消耗。
  • 不传 quota_types 或传空数组时,查询全部用量类型。

请求参数

入参类型含义是否必填
team_idstring团队ID
brand_idstring品牌ID;不传或传 0 表示团队范围
start_unixint64开始时间,Unix秒时间戳
end_unixint64结束时间,Unix秒时间戳
quota_typesstring 数组用量类型列表

响应参数

返回值类型含义
period_startint64统计开始时间,Unix秒时间戳
period_endint64统计结束时间,Unix秒时间戳
total_credit_usedint积分消耗总量
total_quota_amountint资源消耗总量
usagesobject 数组按用量类型汇总的消耗列表
usages.quota_typestring用量类型
usages.quota_amountint该类型资源消耗量
usages.credit_usedint该类型积分消耗量
usages.percentfloat占积分消耗总量的百分比

响应示例:

{ "code": 0, "msg": "success", "data": { "period_start": "1780243200", "period_end": "1782835199", "total_credit_used": 1100, "total_quota_amount": 83, "usages": [ { "quota_type": "article_generate", "quota_amount": 80, "credit_used": 800, "percent": 72.73 }, { "quota_type": "video_generate", "quota_amount": 3, "credit_used": 300, "percent": 27.27 } ] } }

获取积分消耗趋势

  • 请求方法:POST
  • 请求路径:/geo/billing/credit/trend

说明:

  • 该接口用于获取计量中心「积分消耗」中的按日趋势。
  • 不传 start_unixend_unix 时,默认查询当前计费周期。
  • 不传 brand_id 或传入 0 时查询团队范围;传入品牌ID时查询该品牌相关消耗。
  • 不传 quota_types 或传空数组时,查询全部用量类型。

请求参数

入参类型含义是否必填
team_idstring团队ID
brand_idstring品牌ID;不传或传 0 表示团队范围
start_unixint64开始时间,Unix秒时间戳
end_unixint64结束时间,Unix秒时间戳
quota_typesstring 数组用量类型列表

响应参数

返回值类型含义
period_startint64统计开始时间,Unix秒时间戳
period_endint64统计结束时间,Unix秒时间戳
trendsobject 数组每日消耗趋势
trends.datestring日期,格式:YYYY-MM-DD
trends.quota_typestring用量类型
trends.quota_amountint当日资源消耗量
trends.credit_usedint当日积分消耗量

响应示例:

{ "code": 0, "msg": "success", "data": { "period_start": "1780243200", "period_end": "1782835199", "trends": [ { "date": "2026-08-30", "quota_type": "article_generate", "quota_amount": 5, "credit_used": 50 } ] } }

获取品牌积分消耗排行

  • 请求方法:POST
  • 请求路径:/geo/billing/credit/rank

说明:

  • 该接口用于获取计量中心积分卡「品牌消耗」下拉中的品牌排行。按消耗量从高到低返回,仅统计有品牌归属的消耗记录。
  • 不传 start_unixend_unix 时,默认查询当前计费周期。

请求参数

入参类型含义是否必填
team_idstring团队ID
start_unixint64开始时间,Unix秒时间戳
end_unixint64结束时间,Unix秒时间戳

响应参数

返回值类型含义
brand_idstring品牌ID
brand_namestring品牌名称
credit_usedint积分消耗量

响应示例:

{ "code": 0, "msg": "success", "data": [ { "brand_id": "brand_test_001", "brand_name": "测试品牌A", "credit_used": 1200 }, { "brand_id": "brand_test_002", "brand_name": "测试品牌B", "credit_used": 860 } ] }

获取积分流水

  • 请求方法:POST
  • 请求路径:/geo/billing/credit/bills

说明:

  • 该接口用于获取计量中心「操作记录」中的积分流水。
  • 不传 start_timeend_time 时,默认查询当前计费周期。
  • 不传 brand_id 或传入 0 时查询团队范围;传入品牌ID时查询该品牌相关流水。

请求参数

入参类型含义是否必填
team_idstring团队ID
brand_idstring品牌ID;不传或传 0 表示团队范围
pageint页码;不传默认 1
page_sizeint每页数量
start_timeint64开始时间,Unix秒时间戳
end_timeint64结束时间,Unix秒时间戳
keywordstring按操作人或事件名称搜索
statusint流水状态:0-不筛选,1-冻结中,2-已确认

响应参数

返回值类型含义
billsobject 数组积分流水列表
bills.bill_idstring流水ID
bills.team_idstring团队ID
bills.bill_typestring事件类型展示文案
bills.credit_changeint积分变动值
bills.is_pendingbool是否冻结中:true-冻结中,false-已确认
bills.created_timeint64创建时间,Unix秒时间戳
bills.operator_namestring操作人名称
bills.brand_namestring品牌名称
totalint流水总数

响应示例:

{ "code": 0, "msg": "success", "data": { "bills": [ { "bill_id": "bill_test_001", "team_id": "team_test_001", "bill_type": "文章生成", "credit_change": -10, "is_pending": false, "created_time": "1780012800", "operator_name": "test_user", "brand_name": "测试品牌A" } ], "total": 1 } }

获取订阅日志

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

说明:

  • 该接口用于获取计量中心「操作记录」中的订阅日志。

请求参数

入参类型含义是否必填
team_idstring团队ID
pageint页码;不传默认 1
page_sizeint每页数量
keywordstring按操作人或事件名称搜索

响应参数

返回值类型含义
listobject 数组订阅日志列表
list.log_idstring日志ID
list.actionstring事件标识
list.action_textstring事件名称
list.messagestring事件说明
list.operator_namestring操作人名称
list.created_atint64创建时间,Unix秒时间戳
totalint日志总数

响应示例:

{ "code": 0, "msg": "success", "data": { "list": [ { "log_id": "log_test_001", "action": "purchase", "action_text": "分配套餐", "message": "分配了专业版,有效期 30 天", "operator_name": "test_user", "created_at": "1780012800" } ], "total": 1 } }

获取配额记录

  • 请求方法:POST
  • 请求路径:/geo/billing/quota/override/list

说明:

  • 该接口用于获取计量中心「操作记录」中的配额记录。

请求参数

入参类型含义是否必填
team_idstring团队ID
pageint页码;不传默认 1
page_sizeint每页数量

响应参数

返回值类型含义
listobject 数组配额记录列表
list.quota_typestring用量类型
list.quota_limitint调整后的额度
list.reasonstring调整原因
list.created_atint64创建时间,Unix秒时间戳
list.is_effectivebool当前是否生效:true-已生效,false-未生效
totalint记录总数

响应示例:

{ "code": 0, "msg": "success", "data": { "list": [ { "quota_type": "max_brand", "quota_limit": 5, "reason": "扩容品牌数量", "created_at": "1780012800", "is_effective": true } ], "total": 1 } }

概览页数据

说明:

  • 以下接口对应控制台品牌首页「概览」:顶部指标卡、品牌趋势、竞品对比、分组明细、引用域名排行、引用文章排行。
  • 筛选条件与页面顶部一致:时间范围、大模型、用户提问分类、提问标签。未传 platformstitle_idstag_ids 时表示不限制。
  • fluctuation 的指标中,value 为当前值,fluctuation 为相对上一同等长度周期的变化值。
  • 品牌提及率为百分比;平均排名仅统计已提及品牌的回答,数值越小表示排名越靠前。
  • 用户提问分类ID可通过「获取用户提问分类列表」取得;竞品ID可通过「获取竞品列表」取得。

获取概览指标

  • 请求方法:POST
  • 请求路径:/geo/base/dashboard

说明:

  • 该接口用于获取首页顶部的品牌提及率、平均排名、曝光效果分数。
  • brand_idbegin_dateend_date 必填。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表

响应参数

返回值类型含义
exposure.valuefloat品牌提及率
exposure.fluctuationfloat品牌提及率变化值
avg_rank.valuefloat平均排名
avg_rank.fluctuationfloat平均排名变化值
score.valuefloat曝光效果分数
score.fluctuationfloat曝光效果分数变化值

响应示例:

{ "code": 0, "msg": "success", "data": { "exposure": { "value": 8.5, "fluctuation": -0.2 }, "avg_rank": { "value": 5.2, "fluctuation": 2.62 }, "score": { "value": 6, "fluctuation": -1.1 } } }

获取监控用户提问

  • 请求方法:POST
  • 请求路径:/geo/prompt/trends

说明:

  • 该接口用于获取首页顶部的监控用户提问数量、变化值,以及按日变化趋势。
  • brand_idbegin_dateend_date 必填。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
tag_idsstring 数组提问标签ID列表

响应参数

返回值类型含义
prompt_countint当前监控用户提问数
fluctuationint监控用户提问数变化值
prompt_trendsobject 数组按日变化趋势
prompt_trends.datestring日期,格式:YYYY-MM-DD
prompt_trends.prompt_countint当日监控用户提问数

响应示例:

{ "code": 0, "msg": "success", "data": { "prompt_count": 46, "fluctuation": 2, "prompt_trends": [ { "date": "2026-08-25", "prompt_count": 44 }, { "date": "2026-08-31", "prompt_count": 46 } ] } }

获取品牌提及率趋势

  • 请求方法:POST
  • 请求路径:/geo/exposure/trends

说明:

  • 该接口用于获取首页「品牌趋势」中的品牌提及率、平均排名按日数据,以及已选竞品的同期数据。
  • brand_idbegin_dateend_date 必填。
  • 未传 competitor_ids 时,仅返回本品牌趋势。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
competitor_idsstring 数组竞品ID列表
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表

响应参数

返回值类型含义
brand_statisticsobject 数组本品牌按日统计
brand_statistics.datestring日期,格式:YYYY-MM-DD
brand_statistics.namestring品牌名称
brand_statistics.exposurefloat品牌提及率
brand_statistics.avg_rankfloat平均排名
brand_statistics.task_countint当日监测回答数
competitor_statisticsobject 数组竞品按日统计
competitor_statistics.competitor_idstring竞品ID
competitor_statistics.namestring竞品名称
competitor_statistics.statisticsobject 数组该竞品按日统计
competitor_statistics.statistics.datestring日期,格式:YYYY-MM-DD
competitor_statistics.statistics.exposurefloat竞品提及率
competitor_statistics.statistics.avg_rankfloat竞品平均排名
competitor_statistics.statistics.task_countint当日监测回答数

响应示例:

{ "code": 0, "msg": "success", "data": { "brand_statistics": [ { "date": "2026-08-25", "name": "测试品牌A", "exposure": 8.7, "avg_rank": 5.1, "task_count": 46 }, { "date": "2026-08-31", "name": "测试品牌A", "exposure": 8.5, "avg_rank": 5.2, "task_count": 46 } ], "competitor_statistics": [ { "competitor_id": "competitor_test_001", "name": "测试竞品A", "statistics": [ { "date": "2026-08-25", "exposure": 2.1, "avg_rank": 7.4, "task_count": 46 }, { "date": "2026-08-31", "exposure": 1.98, "avg_rank": 7.6, "task_count": 46 } ] } ] } }

获取曝光效果分数趋势

  • 请求方法:POST
  • 请求路径:/geo/score/trends

说明:

  • 该接口用于获取首页「品牌趋势」切换为曝光效果分数时的按日数据,以及已选竞品的同期数据。
  • brand_idbegin_dateend_date 必填。
  • 未传 competitor_ids 时,仅返回本品牌趋势。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
competitor_idsstring 数组竞品ID列表
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表

响应参数

返回值类型含义
brand_statisticsobject 数组本品牌按日统计
brand_statistics.datestring日期,格式:YYYY-MM-DD
brand_statistics.namestring品牌名称
brand_statistics.scorefloat曝光效果分数
brand_statistics.task_countint当日监测回答数
competitor_statisticsobject 数组竞品按日统计
competitor_statistics.competitor_idstring竞品ID
competitor_statistics.namestring竞品名称
competitor_statistics.statisticsobject 数组该竞品按日统计
competitor_statistics.statistics.datestring日期,格式:YYYY-MM-DD
competitor_statistics.statistics.scorefloat竞品曝光效果分数
competitor_statistics.statistics.task_countint当日监测回答数

响应示例:

{ "code": 0, "msg": "success", "data": { "brand_statistics": [ { "date": "2026-08-25", "name": "测试品牌A", "score": 7.1, "task_count": 46 }, { "date": "2026-08-31", "name": "测试品牌A", "score": 6, "task_count": 46 } ], "competitor_statistics": [ { "competitor_id": "competitor_test_001", "name": "测试竞品A", "statistics": [ { "date": "2026-08-25", "score": 3.2, "task_count": 46 }, { "date": "2026-08-31", "score": 2.8, "task_count": 46 } ] } ] } }

获取品牌与竞品提及率对比

  • 请求方法:POST
  • 请求路径:/geo/exposure/rank

说明:

  • 该接口用于获取首页「竞品对比」中的品牌提及率、平均排名对比结果。
  • brand_idbegin_dateend_date 必填。
  • competitor_id0 表示当前品牌,其余为竞品。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
competitor_idsstring 数组竞品ID列表;不传时返回本品牌及全部竞品
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表

响应参数

返回值类型含义
competitor_idstring对比对象ID;0 表示当前品牌
competitor_namestring对比对象名称
exposurefloat品牌提及率
fluctuationfloat品牌提及率变化值
avg_rank.valuefloat平均排名
avg_rank.fluctuationfloat平均排名变化值

响应示例:

{ "code": 0, "msg": "success", "data": [ { "competitor_id": "0", "competitor_name": "测试品牌A", "exposure": 8.5, "fluctuation": -0.2, "avg_rank": { "value": 5.2, "fluctuation": 2.62 } }, { "competitor_id": "competitor_test_001", "competitor_name": "测试竞品A", "exposure": 1.98, "fluctuation": 0.1, "avg_rank": { "value": 7.6, "fluctuation": 0.2 } } ] }

获取品牌与竞品曝光效果分数对比

  • 请求方法:POST
  • 请求路径:/geo/score/rank

说明:

  • 该接口用于获取首页「竞品对比」切换为曝光效果分数时的对比结果。
  • brand_idbegin_dateend_date 必填。
  • competitor_id0 表示当前品牌,其余为竞品。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
competitor_idsstring 数组竞品ID列表;不传时返回本品牌及全部竞品
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表

响应参数

返回值类型含义
competitor_idstring对比对象ID;0 表示当前品牌
competitor_namestring对比对象名称
scorefloat曝光效果分数
fluctuationfloat曝光效果分数变化值

响应示例:

{ "code": 0, "msg": "success", "data": [ { "competitor_id": "0", "competitor_name": "测试品牌A", "score": 6, "fluctuation": -1.1 }, { "competitor_id": "competitor_test_001", "competitor_name": "测试竞品A", "score": 2.8, "fluctuation": -0.4 } ] }

获取分组指标

  • 请求方法:POST
  • 请求路径:/geo/title/rank

说明:

  • 该接口用于获取首页底部按用户提问分类汇总的提及率、平均排名、曝光效果分数。
  • brand_idbegin_dateend_date 必填。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表

响应参数

返回值类型含义
exposureobject 数组按分类汇总的品牌提及率
exposure.title_idstring用户提问分类ID
exposure.title_namestring用户提问分类名称
exposure.exposurefloat品牌提及率
exposure.fluctuationfloat品牌提及率变化值
avg_rankobject 数组按分类汇总的平均排名
avg_rank.title_idstring用户提问分类ID
avg_rank.title_namestring用户提问分类名称
avg_rank.avg_rankfloat平均排名
avg_rank.fluctuationfloat平均排名变化值
scoreobject 数组按分类汇总的曝光效果分数
score.title_idstring用户提问分类ID
score.title_namestring用户提问分类名称
score.scorefloat曝光效果分数
score.fluctuationfloat曝光效果分数变化值

响应示例:

{ "code": 0, "msg": "success", "data": { "exposure": [ { "title_id": "title_test_001", "title_name": "产品选型", "exposure": 12.5, "fluctuation": 1.2 } ], "avg_rank": [ { "title_id": "title_test_001", "title_name": "产品选型", "avg_rank": 4.8, "fluctuation": -0.3 } ], "score": [ { "title_id": "title_test_001", "title_name": "产品选型", "score": 7, "fluctuation": 0.5 } ] } }

获取引用域名排行

  • 请求方法:POST
  • 请求路径:/geo/domain/rank

说明:

  • 该接口用于获取首页「引用域名排行榜」。按引用次数降序返回大模型回答中引用过的域名。
  • brand_idbegin_dateend_date 必填。
  • 首页预览通常传 page=1page_size=5;查看全部时按分页拉取,total 为符合条件的域名总数。

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
prompt_idsstring 数组用户提问ID列表
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表
domainstring域名关键字,按域名模糊匹配
pageint页码,从 1 开始
page_sizeint每页数量

响应参数

返回值类型含义
reference_countobject 数组引用域名列表,按引用次数降序
reference_count.domainstring引用域名
reference_count.countint引用次数
reference_count.is_ownbool是否为当前品牌官网域名
totalint符合条件的域名总数

响应示例:

{ "code": 0, "msg": "success", "data": { "reference_count": [ { "domain": "www.iesdouyin.com", "count": 829, "is_own": false }, { "domain": "blog.csdn.net", "count": 252, "is_own": false } ], "total": 347 } }

获取引用文章排行

  • 请求方法:POST
  • 请求路径:/geo/article/rank

说明:

  • 该接口用于获取首页「引用文章排行榜」。按引用次数降序返回大模型回答中引用过的文章。
  • brand_idbegin_dateend_date 必填。
  • 首页预览通常传 page=1page_size=5;查看全部时按分页拉取,total 为符合条件的文章总数。
  • 未纳入平台追踪的文章,article_id 为空,source0

请求参数

入参类型含义是否必填
brand_idstring品牌ID
begin_datestring开始日期,格式:YYYY-MM-DD
end_datestring结束日期,格式:YYYY-MM-DD
title_idsstring 数组用户提问分类ID列表
prompt_idsstring 数组用户提问ID列表
platformsstring 数组大模型平台筛选;空数组或不传表示全部平台
tag_idsstring 数组提问标签ID列表
keywordstring关键字,按文章标题或域名模糊匹配
pageint页码,从 1 开始
page_sizeint每页数量

响应参数

返回值类型含义
reference_countobject 数组引用文章列表,按引用次数降序
reference_count.articlestring文章标题
reference_count.urlstring文章链接
reference_count.domainstring文章所属域名
reference_count.countint引用次数
reference_count.sourceint文章来源:0-未关联追踪文章,1-平台创作,2-用户创作,3-官网文章
reference_count.article_idstring已追踪文章的文章ID;未追踪时为空
totalint符合条件的文章总数

响应示例:

{ "code": 0, "msg": "success", "data": { "reference_count": [ { "article": "谁说20岁的女生要用贵价护肤品", "url": "https://www.iesdouyin.com/share/video/example", "domain": "www.iesdouyin.com", "count": 38, "source": 0, "article_id": "" }, { "article": "新手护肤入门看这一篇就够", "url": "https://blog.csdn.net/example/article", "domain": "blog.csdn.net", "count": 38, "source": 2, "article_id": "article_test_001" } ], "total": 1052 } }

获取可筛选的大模型平台

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

说明:

  • 该接口用于获取当前团队可用的大模型平台列表,作为概览页 platforms 入参使用。

请求参数

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

响应参数

返回值类型含义
dataobject平台映射;key 为平台展示名,value 为平台标识

响应示例:

{ "code": 0, "msg": "success", "data": { "DEEPSEEK": "deepseek", "DOUBAO": "doubao", "YUANBAO": "yuanbao", "KIMI": "kimi", "CHATGPT": "chatgpt" } }
Answerbit - AI搜索可见度追踪平台