GET /v1/monitors/{id}/analytics(リファレンス)は、モニターのレポートの
すべての数字を1つの回答集合から返します。1つの期間、1つのフィルターセット、そして比較のための直前の同じ長さの期間です。
自社レポートのすべてのパネルをこのエンドポイントから作り、数字の前に quality を読んでください。レポートの読み取りは
無料です。
クエリパラメーター
期間は半開区間でUTC基準です。
since は含み、until は含みません。直前の期間はまったく同じ長さで since で終わり、
同じフィルターを使うため、すべての比較は同条件です。各パラメーターは1回だけ送ってください。
例
たとえば、ChatGPT に2つのプロンプトを1日1回samples: 5 で質問する(1日10回答)ブランドモニターを、2日間 ChatGPT で
絞り込むと、次を返します。
quality.lowSample が true なので、この変化は傾向ではなく確認すべき兆候として扱ってください。
レスポンスのセクション
比率オブジェクト
stats、previous、engineRates と series の各エントリ、各プロンプト、各セルは同じフィールドを持ちます。
セル
セルは1つのエンジン上の1つのプロンプトです。比率オブジェクトと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 × そのブランドの言及 / 追跡中の全ブランドの言及なので、1つの期間のシェアを 合計すると100になります(分母はquality.trackedBrandMentions)。これらのプロンプトで収集した回答の中でブランドを 比較する値であり、市場シェアでも可視性のランキングでもありません。competitorOnlyとopportunitiesは、自社ブランドがなく競合を挙げた回答を数えます。手を打てるギャップです。nullは0ではありません。 割る回答がなければ比率はnullです。0は回答があり1つも一致しなかったことを 意味します。- テキストのない回答は「言及なし」として数えます。 回答を返さずに完了したタスクは分母に残り、
quality.noAnswerObservationsがその数を示します。失敗したタスクはすべての比率から除外され、healthにだけ 現れます。壊れたエンジンは不在として現れるのではなく、サンプルを減らします。 - 採点済みの回答の
positionは、自社ブランドが最初に一致した箇所の文字オフセットです。順位ではなく目立ち具合の 代理指標です。ブランドがなければnullです。
比較が保留される場合
2つの期間を比較できない場合、changes、各セルの mentionRateChangePp、各ブランドの previousMentionRate と
previousShareOfVoice は null になり、quality.comparable は false です。理由は quality.comparisonReason が
示します。
すべての回答は採点時の定義を保持し、
quality.scoringVersions は両期間の異なる定義を列挙します(定義のない回答は
legacy)。エイリアスや競合を変えても過去の回答が書き換わることはありません。唯一の例外は週次の競合読み取りで、
見つけた競合が変わると、モニターに保存された回答を新しい一覧で採点し直します。
品質
ヘルス
health は、処理中または直近24時間に終了したモニターのタスクについて、completed、failed、pending、topError
(失敗したタスクで最も多いエラーコード)を持ちます。healthScope は常に recent_visible_tasks です。期間とは独立した
実行の診断情報で、比率の分母には決して含まれません。
実行中にポーリングする
すべての呼び出しは、その期間とフィルターでの完全なレポートを返します。実行中は、health.pending がまだ処理中のタスク数を
数えます。0になったらレポートを読み直してください。
カテゴリレポート
カテゴリモニターは同じエンドポイントから異なるボディを返します。window、filters、
quality、pauses、health は同じです。
statsとpreviousはruns、named(追跡ブランドを1つ以上挙げた回答)、namedRateを持ちます。changes.namedRatePpはポイント差です。categoryが順位を持ちます。
たとえば、
category.brands の1エントリ:
rankは、ブランドを挙げた回答の数で順序付けします。どの回答にも挙げられなかったブランドはrank: nullです。mentionRateはブランド自身のsampleSize(一覧にあった間に採点された回答)で割ります。shareOfVoiceは期間内の100 × そのブランドの言及 / 全ブランドの言及なので、シェアの合計は100になります。
エラーと上限
- 期間は最大90日です。
- 不正なパラメーターは問題を示すメッセージ付きで
400 VALIDATION_ERRORを返します:sinceまたはuntilとdaysの 併用、sinceとuntilの一方だけ、タイムゾーンのない時刻、90日を超える期間、未来のuntil、モニターできない エンジン、2,000文字を超えるプロンプト、繰り返されたパラメーター。 - 集計するには大きすぎるレポートは「This report is too large」付きで
400 VALIDATION_ERRORを返します。期間、 エンジン、プロンプトを絞ってください。
次のステップ
ソースと回答
引用されたページと、各数字の裏にある回答。
イベントとアラート
回答が変わったときに通知を受け取ります。