引用されているソース
GET /v1/monitors/{id}/sources(リファレンス)は、エンジンが引用した
ドメインまたはページを、レポートと同じ期間とフィルターで順位付けします。生の引用数ではなく異なる回答の数を数える
ため、1つの回答で3回引用されたページも1回と数えます。
例:
行は
citations、次に key の順に並びます。最後のページでは nextCursor が null です。上位N件の切り捨てはないため、
期間内に引用されたすべてのドメインやページに到達できます。カーソルは不透明な値として扱ってください。
引用の推移
GET /v1/monitors/{id}/citations(リファレンス)は、ダッシュボードの
引用チャートの裏にあるデータを返します: 期間の合計、日別系列、上位20件のドメインとページ(それぞれ独自の日別系列付き)。
ここでの引用1件は、1つの回答に現れた1つのページなので、
citations は回答ではなく引用されたページを数えます。
/sources は異なる回答の数を数えるため、数値が異なる場合があります。
自社ドメインの
kind は owned です。その他の種類は既知の媒体の固定リストに基づき、不明なものは other です。
ソースのシェアは、その citations を totals.citations で割った値です。kind、q、offset が絞るのは domains、
pages、pagination だけで、totals、days、types は常に期間内のすべてのソースを対象にします。
回答を1件読む
GET /v1/monitors/{id}/answers/{taskId}(リファレンス)は、1つのスコアの裏に
ある保存済みの回答を、照合対象とともに返します。言及を鵜呑みにせず確認できます。タスクidはレポートの
evidenceTaskId、mentionTaskId、latestTaskId、/sources、エクスポートした行から得られます。
このモニターの採点済み回答ではないタスクidは
404 NOT_FOUND を返します。
1つのプロンプトの詳細
GET /v1/monitors/{id}/prompt(リファレンス)は1つのプロンプトのデータを
返します。prompt(完全一致のテキスト)は必須で、モニターから外したプロンプトにも使えます。days は 7、30(既定)、
90 です。
ここでの
citations は、異なる回答の数ではなく、回答全体で引用されたページを数えます。1つのプロンプトについて
ページネーション付きの完全なソース一覧が必要なら /sources?prompt=... を使ってください。
位置ごとの回答
GET /v1/monitors/{id}/grid(リファレンス)は、モニターの現在の
位置またはグリッドの地点ごとの回答を返します。任意の engine(モニターのエンジンの
いずれか)と prompt で絞り込めます。days は 7、30(既定)、90 です。
レスポンスは location、grid、engine、prompt、windowDays、points を持ちます。各地点は row、col、
location、runs、mentioned、cited、topCompetitor({ name, mentions } または null)、latest(最新の回答の
{ taskId, engine, mentioned, ranAt }、または null)を持ちます。回答は正確な座標で地点に対応付けるため、同じ
モニターの以前の位置やグリッドからの回答は除外されます。位置もグリッドもないモニターは地点を返しません。
採点済みの回答をエクスポートする
GET /v1/monitors/{id}/results(リファレンス)は採点済みの回答
そのものを返します。データウェアハウスへのロード、スプレッドシート、報告資料に使ってください。新しい回答をすべて
スケジュールに従ってクラウドストレージに届けたい場合は、結果のエクスポートを参照してください。
JSONレスポンスの例:
ranAt(マイクロ秒精度)と行の id によるキーセット方式なので、同じタイムスタンプ
を共有する行も抜けたり重複したりしません。抽出を再現可能にするには、明示的な since と until を送り、固定したまま、
nextCursor が null になるまでたどってください。ページの間で期間を変えると、行が抜けたり重複したりすることが
あります。カーソルは不透明な値として扱ってください。
CSV
format=csv の場合、レスポンスは text/csv で、スプレッドシートアプリが正しく開けるようBOM付きのUTF-8です。CSV本文には
ページネーションの状態を入れられないため、ヘッダーに移ります。
列は
ran_at, monitor, engine, prompt, mentioned, cited, position, competitors, task_id で、includeEvidence=true の
ときは answer_text, sources, scoring_context が加わります。competitors は名前を | で連結し、sources と
scoring_context はJSONテキストを持ちます。=、+、-、@、タブ、復帰文字で始まるセルには ' を前置するため、
エンジンのテキストがスプレッドシートの数式になることはありません。
エラーと上限
不正なパラメーターは、前のページが返したものではないカーソルを含め、問題を示す
400 VALIDATION_ERROR を返します。
他のアカウントのモニターや不明なタスクidは 404 NOT_FOUND を返します。共通のコードはモニターを
参照してください。
次のステップ
イベントとアラート
プロンプトの回答が変わったときにWebhookを受け取ります。
結果のエクスポート
採点済みの回答をスケジュールに従って自社ストレージに届けます。