> ## Documentation Index > Fetch the complete documentation index at: https://docs.tryprofound.com/llms.txt > Use this file to discover all available pages before exploring further. # はじめに > Profound API を使って Profound のダッシュボードを再現するためのエンドツーエンドのレシピ Cookbook は、Profound アプリに表示される各チャート、KPI、テーブルを公開 API の呼び出しだけで再現する方法を示す**エンドツーエンドのレシピ**集です。各レシピは単体で完結しており、使用する正確なエンドポイントを示し、リクエストの形式を説明したうえで、自分のコードにコピーできる実行可能な Python と `curl` を掲載しています。エンドポイントのリファレンス(すべてのパラメータ、すべてのメトリクス)だけが必要な場合は、 [REST API](/ja-jp/rest-api/introduction) タブをご覧ください。Cookbook はその上のレイヤーで、 API を使って多くの人が**構築**したいと考える一般的なものを扱います。 ## AI アシスタントにコンテキストを与える Claude、ChatGPT、Cursor などの AI コーディングアシスタントを使って構築していますか? 次の URL を貼り付けてください。このドキュメントの全ページのコンパクトなインデックスで、アシスタントが必要に応じて取得できます。 ``` https://docs.tryprofound.com/llms.txt ``` ## 必要なもの Profound アプリの **Settings → API Keys** で生成します。まだお持ちでない場合は [認証](/ja-jp/rest-api/authentication) をご覧ください。すべてのレポートクエリはカテゴリにスコープされます。名前からカテゴリを調べるには [カテゴリ ID を見つける](/ja-jp/cookbook/setup/find-your-category-id) をご覧ください。最も一般的な方法であるため、レシピはデフォルトで Python SDK を使用します。 `pip install profound` でインストールしてください。REST API を直接呼び出したい場合のために、すべてのレシピに `curl` タブも用意しています。 ## 初回のみのセットアップすべてのレシピは、次のようにクライアントを作成するところから始まります(複数のレシピを組み合わせる場合でも、1 つのスクリプトにつき 1 回だけ必要です)。 ```python Python theme={null} import os from profound import Profound client = Profound(api_key=os.environ["PROFOUND_API_KEY"]) ``` ```bash curl theme={null} export PROFOUND_API_KEY=your_api_key_here ``` ## すべてのレシピで使われる規約始める前に理解しておくべきことが 3 つあります。これらはすべてのレシピに登場し、多くの新規ユーザーがつまずくポイントです。 API は `end_date` をその日の開始時点として解釈するため、送信した日付は**含まれません**。 `2026-05-10` 全体を含めるには、`end_date="2026-05-11"` を送信します。ユーザーには包含的な値を表示し、API には `+1 day` した値を送信してください。すべてのレスポンスには `info.query.metrics` と `info.query.dimensions` が含まれており、各行の `metrics` 配列と `dimensions` 配列を構成する際に API が使用した正確な順序が返されます。 ```python theme={null} order = res.info.query["metrics"] # e.g. ["visibility_score"] i = order.index("visibility_score") score = res.data[0].metrics[i] ``` 位置をハードコードしないでください。`info.query` から読み取ることで、どのようなメトリクスの組み合わせをリクエストしてもコードが正しく動作します。期間比較の変化(各 KPI タイルに表示される緑/赤の `+1.0%`)はクライアント側で計算されます。同じ呼び出しを 2 回(現在の期間に 1 回、同じ長さの前の期間に 1 回)実行し、コード内で 2 つのスコアの差を求めてください。 ## 構築を始める前にレート制限、排他的な終了日、`info.query` の順序、エラー、ページネーション。一度読んで、AI アシスタントに貼り付けてください。 Categories、Topics、Prompts、Tags、Assets、Personas の関係。すべてのエンドポイント、そのメトリクス/ディメンション、用途を一目で確認できる 1 ページ。各メトリクスの計算式、計算例、そして Answers API から各数値を再現する方法。 Topics、Tags、ブランドは現在の設定に基づいて適用されるため、設定を編集すると過去の数値も変わります。 ## レシピ ### セットアップキーで参照できるカテゴリを一覧表示し、プログラムで 1 つを選択します。カテゴリ内のすべてのアセットを、`is_owned` フラグとドメインとともに取得します。 ### Visibility 期間内のアセットのスコアと、前の期間からの変化。アセットの日次 / 週次 / 月次の折れ線グラフを作成します。両方を一度に取得します。なぜ別々の呼び出しなのかを理解しましょう。任意の可視性メトリクスで、カテゴリ内のすべてのアセットをランク付けします。任意に選んだアセットのセットの複数折れ線グラフ。 1 つのアセットのスコアを、回答した AI サーフェス別に分解します。 ### Citations 全引用に占める自社ドメインのシェアと、期間比較の変化。日次の自社ドメインシェアの折れ線**と**日次の総引用量を、 1 回の呼び出しで取得します。引用されたすべてのドメインをシェア順にランク付けし、行ごとの pp 差分列を表示します。