跳转到主要内容
GET /v1/monitors/{id}/analytics(参考)基于同一组回答返回监测器报告中的每个数字: 一个窗口、一套过滤条件,以及用于比较的前一个同长窗口。请用这个端点构建你自己报告的每个板块,并在看数字之前先读 quality。读取报告不收费。

查询参数

窗口为左闭右开,使用 UTC:包含 since,不包含 until。前一个窗口长度完全相同,截止于 since,并使用相同的过滤条件,因此每次比较都是同口径的。 每个参数只传一次。

示例

例如,一个品牌监测器每天用 samples: 5 向 ChatGPT 询问两个提示词(每天十个回答),按 ChatGPT 过滤、窗口为两天时返回:
解读:在 20 个 ChatGPT 回答中有 9 个提到了品牌(45%),比之前两天下降 15 个百分点。Northwind Audio 出现在更多回答中, “are cheap earbuds worth it” 是最弱的提示词,有 4 个回答提到了竞争对手却没有提到品牌。quality.lowSample 为 true, 因此请把这一变化当作需要核实的信号,而不是趋势。

响应板块

比率对象

stats、previous、每个 engineRates 和 series 条目、每个提示词以及每个单元格都带有相同的字段:

单元格

单元格是一个提示词在一个引擎上的结果。除比率对象和 previous 外,它还带有: 没有符合条件的回答时,对应 id 为 null。用 GET /v1/monitors/{id}/answers/{taskId} 打开回答。

品牌与声量份额

brands 中的每个条目带有 name、mentions、sampleSize、mentionRate、shareOfVoice、 previousMentionRate、previousShareOfVoice 和 configured(对于窗口内被提到、但已不在监测器上的品牌为 false)。

数字的含义

GET /v1/monitors/capabilities 以 metrics 返回这些定义,客户端可以把它们显示在数字旁边。
  • mentionRate 是 100 × mentioned / 已评分回答数,按窗口、每个引擎、每天和每个单元格计算。它按回答加权,而不是在引擎之间取平均, 因此回答多的引擎不会被回答少的引擎压过。
  • citationRate 形式相同,统计引用了你某个域名的回答。没有域名时它始终为 0,因为引用跟踪是关闭的。
  • 品牌的比率除以它自己的 sampleSize。 对你的品牌而言是所有已评分回答。对竞争对手而言,只是它在监测器上期间评分的回答, 因此今天添加的竞争对手从今天开始测量。窗口内有部分回答在评分上下文保存之前评分时,竞争对手的 mentionRate 为 null,因为无法得知它们当时与什么匹配。
  • shareOfVoice 是窗口内 100 × 该品牌的提及数 / 所有被跟踪品牌的提及总数,因此同一窗口的份额相加为 100(分母为 quality.trackedBrandMentions)。 它比较的是你为这些提示词收集到的回答中的品牌,不是市场份额,也不是可见度排名。
  • competitorOnly 和 opportunities 统计提到了竞争对手而你的品牌缺席的回答:这是你可以着手弥补的差距。
  • null 不等于 0。 没有可作分母的回答时,比率为 null。0 表示有回答,但没有一个匹配。
  • 没有文本的回答计为未提及。 已完成但没有返回回答的任务仍计入分母,quality.noAnswerObservations 统计其数量。失败的任务不计入任何比率, 只出现在 health 中。出故障的引擎会缩小样本,而不会表现为品牌缺席。
  • 已评分回答上的 position 是你的品牌首个匹配的字符偏移量:反映显著程度的近似指标,而不是排名。品牌缺席时为 null。

比较何时被扣留

两个窗口无法比较时,changes、每个单元格的 mentionRateChangePp,以及每个品牌的 previousMentionRate 和 previousShareOfVoice 为 null,quality.comparable 为 false。quality.comparisonReason 说明原因: 每个回答都保留其评分时的定义,quality.scoringVersions 列出两个窗口中不同的定义(没有定义的回答为 legacy)。 修改别名或竞争对手永远不会改写过去的回答。唯一的例外是每周的竞争对手读取:它找出的竞争对手变化时,监测器已保存的回答会按新名单重新评分。

质量

健康状况

health 包含 completed、failed、pending 和 topError(失败任务中最常见的错误码),统计监测器正在进行或在最近 24 小时内完成的任务。 healthScope 始终为 recent_visible_tasks。它是针对运行的诊断信息,与窗口无关,也永远不计入比率的分母。

运行进行中时轮询

每次调用都会返回该窗口和过滤条件下的完整报告。运行进行中时, health.pending 统计其中仍在运行的任务。它变为 0 后再读取一次报告。

品类报告

品类监测器从同一端点返回不同的响应体,window、filters、quality、pauses 和 health 相同:
  • stats 和 previous 包含 runs、named(提到至少一个被跟踪品牌的回答数)和 namedRate。changes.namedRatePp 是以百分点表示的变化。
  • category 包含排名:
例如,category.brands 中的一个条目:
  • rank 按提到品牌的回答数量排序。没有任何回答提到的品牌为 rank: null。
  • mentionRate 除以该品牌自己的 sampleSize:它在名单上期间评分的回答。
  • shareOfVoice 是窗口内 100 × 该品牌的提及数 / 所有品牌的提及总数,因此份额相加为 100。

错误与限制

  • 窗口最长 90 天。
  • 参数无效时返回 400 VALIDATION_ERROR,消息会指出问题:days 与 since 或 until 同时传入、只传了 since 和 until 之一、时间戳没有时区、 时长超过 90 天、until 在未来、引擎无法被监测、提示词超过 2,000 个字符,或参数重复。
  • 报告过大无法聚合时返回 400 VALIDATION_ERROR,消息为 “This report is too large”。请缩小窗口、引擎或提示词范围。
所有监测器端点共用的错误码见监测器。

后续步骤

来源与回答

被引用的页面以及每个数字背后的回答。

事件与提醒

回答变化时接收通知。