curl を掲載しています。
エンドポイントのリファレンス(すべてのパラメータ、すべてのメトリクス)だけが必要な場合は、
REST API タブをご覧ください。Cookbook はその上のレイヤーで、
API を使って多くの人が構築したいと考える一般的なものを扱います。
AI アシスタントにコンテキストを与える
Claude、ChatGPT、Cursor などの AI コーディングアシスタントを使って構築していますか? 次の URL を貼り付けてください。このドキュメントの全ページのコンパクトなインデックスで、 アシスタントが必要に応じて取得できます。必要なもの
1
API キー
Profound アプリの Settings → API Keys で生成します。まだお持ちでない場合は
認証 をご覧ください。
2
カテゴリ ID
すべてのレポートクエリはカテゴリにスコープされます。名前からカテゴリを調べるには
カテゴリ ID を見つける を
ご覧ください。
3
Python SDK(任意)
最も一般的な方法であるため、レシピはデフォルトで Python SDK を使用します。
pip install profound でインストールしてください。REST API を直接呼び出したい場合のために、
すべてのレシピに curl タブも用意しています。初回のみのセットアップ
すべてのレシピは、次のようにクライアントを作成するところから始まります(複数のレシピを 組み合わせる場合でも、1 つのスクリプトにつき 1 回だけ必要です)。すべてのレシピで使われる規約
始める前に理解しておくべきことが 3 つあります。これらはすべてのレシピに登場し、 多くの新規ユーザーがつまずくポイントです。end_date は排他的 — 1 日進める
end_date は排他的 — 1 日進める
API は
end_date をその日の開始時点として解釈するため、送信した日付は含まれません。
2026-05-10 全体を含めるには、end_date="2026-05-11" を送信します。ユーザーには包含的な値を表示し、API には +1 day した値を送信してください。配列の位置は info.query から読み取る
配列の位置は info.query から読み取る
すべてのレスポンスには 位置をハードコードしないでください。
info.query.metrics と info.query.dimensions が含まれており、
各行の metrics 配列と dimensions 配列を構成する際に API が使用した正確な順序が
返されます。info.query から読み取ることで、
どのようなメトリクスの組み合わせをリクエストしてもコードが正しく動作します。API は差分を計算しない — 自分で計算する
API は差分を計算しない — 自分で計算する
期間比較の変化(各 KPI タイルに表示される緑/赤の
+1.0%)は
クライアント側で計算されます。同じ呼び出しを 2 回(現在の期間に 1 回、
同じ長さの前の期間に 1 回)実行し、コード内で 2 つのスコアの差を
求めてください。構築を始める前に
規約と注意点
レート制限、排他的な終了日、
info.query の順序、エラー、
ページネーション。一度読んで、AI アシスタントに貼り付けてください。データモデル
Categories、Topics、Prompts、Tags、Assets、Personas の関係。
エンドポイント一覧
すべてのエンドポイント、そのメトリクス/ディメンション、用途を
一目で確認できる 1 ページ。
メトリクスの計算方法
各メトリクスの計算式、計算例、そして Answers API から各数値を
再現する方法。
過去の数値が変わる理由
Topics、Tags、ブランドは現在の設定に基づいて適用されるため、
設定を編集すると過去の数値も変わります。
レシピ
セットアップ
カテゴリ ID を見つける
キーで参照できるカテゴリを一覧表示し、プログラムで 1 つを選択します。
自社アセットを一覧表示する
カテゴリ内のすべてのアセットを、
is_owned フラグとドメインとともに取得します。Visibility
1 つのアセットの Visibility Score
期間内のアセットのスコアと、前の期間からの変化。
Visibility の推移
アセットの日次 / 週次 / 月次の折れ線グラフを作成します。
ヘッドラインと日次を同時に
両方を一度に取得します。なぜ別々の呼び出しなのかを理解しましょう。
上位 N 件のリーダーボード
任意の可視性メトリクスで、カテゴリ内のすべてのアセットをランク付けします。
競合と比較する
任意に選んだアセットのセットの複数折れ線グラフ。
モデル / 地域 / ペルソナ別にセグメント化する
1 つのアセットのスコアを、回答した AI サーフェス別に分解します。
Citations
Citation Share と差分
全引用に占める自社ドメインのシェアと、期間比較の変化。
Citation Share と引用量の推移
日次の自社ドメインシェアの折れ線と日次の総引用量を、
1 回の呼び出しで取得します。
ドメイン別の Citation Rank
引用されたすべてのドメインをシェア順にランク付けし、行ごとの pp 差分列を表示します。