> ## 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.

# エンドポイント一覧

> Cookbook のレシピで使用する Profound API エンドポイントとその他の主要なエンドポイントグループを、主なメトリクス/ディメンション/フィルターとともに 1 ページで一覧できます

30 秒で全体像をつかみましょう。各行が 1 つのエンドポイントです。クリックすると
パラメータの完全なリファレンスに移動します。このページでは、レシピで使用する
エンドポイントと主要なエンドポイントグループを扱います。完全な一覧(Documents、
Knowledge bases、Projects、Integrations、OpenAI Ads を含む)は
[REST API](/ja-jp/rest-api/introduction) タブにあります。規約(日付、順序、ページネーション)の
詳細については、[規約と注意点](/ja-jp/cookbook/setup/conventions) をご覧ください。

## 組織とセットアップ

| メソッド | パス | 用途 |
| - | - | - |
| `GET` | `/v1/org/categories` | キーで参照できるすべてのカテゴリを一覧表示します。 |
| `GET` | `/v1/org/categories/{id}/assets` | カテゴリ内のアセットを、`is_owned` とドメインとともに取得します。 |
| `GET` | `/v1/org/categories/{id}/topics` | カテゴリに設定された Topics。 |
| `GET` | `/v1/org/categories/{id}/tags` | 設定された Tags。 |
| `GET` | `/v1/org/categories/{id}/personas` | 設定された Personas。 |
| `GET` | `/v1/org/categories/{id}/regions` | カテゴリで有効になっている Regions。 |
| `GET` | `/v1/org/categories/{id}/citation-categories` | カテゴリの引用カテゴリフィルターの選択肢。 |
| `GET` | `/v1/org/categories/{id}/citation-tags` | カテゴリに定義されたカスタム引用タグ。 |
| `GET` | `/v1/org/assets` | 組織全体のアセット。 |
| `GET` | `/v1/org/regions` | 組織で有効になっている Regions。 |
| `GET` | `/v1/org/models` | 組織で有効になっている AI モデル(ChatGPT、Claude など)。 |
| `GET` | `/v1/org/domains` | 組織が所有するドメイン。 |
| `GET` | `/v1/org/personas` | 組織で有効になっている Personas。 |

## レポート

Answer Engine Insights のレポートエンドポイントは、`category_id` でスコープされる `POST`
リクエストで、`{info, data}` 形式を返します。Visibility、citations、
sentiment、query-fanouts のレポートは、`category_id`、`start_date`、
`end_date`、`metrics` に加えて、レポート固有の任意フィールドを受け付けます。

トラフィックレポートは異なる形式を使用します。bots と referrals は `category_id` ではなく
`domain` でスコープされます。V2 FactCheck レポートと V2 プロンプト
回答はカテゴリと日付でスコープされますが、`metrics` フィールドは受け付けません。

### `/v1/reports/visibility`

AI の回答にアセットがどのくらいの頻度で登場するか。

| メトリクス | ディメンション | 一般的なフィルター |
| - | - | - |
| `visibility_score`, `share_of_voice`, `average_position`, `mentions_count`, `executions` | `date`, `asset_name`, `model`, `region`, `persona`, `topic`, `tag` | `asset_name`, `model_id`, `region_id`, `persona_id`, `topic_id`, `tag_id` |

一般的なレシピ: [Visibility Score(差分付き)](/ja-jp/cookbook/visibility/asset-visibility-score)、
[推移](/ja-jp/cookbook/visibility/visibility-over-time)、
[リーダーボード](/ja-jp/cookbook/visibility/leaderboard)、
[競合との比較](/ja-jp/cookbook/visibility/compare-competitors)、
[モデル/地域/ペルソナ別のセグメント化](/ja-jp/cookbook/visibility/segment-by-model)。

### `/v1/reports/citations`

AI の回答がどの URL とドメインを引用しているか。

| メトリクス | ディメンション | 一般的なフィルター |
| - | - | - |
| `count`, `citation_share` | `date`, `root_domain`, `url`, `citation_category`, `model`, `region`, `persona` | `prompt_type`(例: `"visibility"`), `model_id`, `region_id`, `persona_id` |

一般的なレシピ: [Citation Share と差分](/ja-jp/cookbook/citations/citation-share)、
[シェアと引用量の推移](/ja-jp/cookbook/citations/citation-share-over-time)、
[ドメイン別ランク](/ja-jp/cookbook/citations/top-citing-domains)。

<Note>
  `citation_share` は AI モデルごとの平均値です。`count` は生の数値です。
  一方で並べ替えても、もう一方の順序とは一致しません。答えたい問いを
  決めて、それに対応するメトリクスで並べ替えてください。
</Note>

### `/v1/reports/sentiment`

AI の回答がアセットをどの程度ポジティブ/ネガティブに言及しているか。

| メトリクス | ディメンション | 一般的なフィルター |
| - | - | - |
| `positive`, `negative`, `occurrences` | `date`, `asset_name`, `theme`, `sentiment_type`, `topic`, `model`, `region`, `persona` | `asset_name`, `theme`, `topic_id`, `model_id`, `region_id`, `persona_id` |

<Warning>
  `/v1/reports/sentiment` はレガシーのセンチメントプロセッサであり、その数値は
  Profound アプリのヘッドライン値とは一致しません。アプリは
  Sentiment v2 からデータを読み取ります。`POST /v2/reports/sentiment` を使用してください
  ([フィルタリングと概念](/ja-jp/rest-api/reports/reports-v2-overview) を参照)。その
  `positive_sentiment` / `negative_sentiment` メトリクスは行ごとに合計 100 になる
  パーセンテージであるため、v1 のカウントとは比較できません。
</Warning>

### `/v1/reports/query-fanouts`

クエリファンアウトのビュー(プロンプトが AI サーフェス全体にどのように波及するか)。同じ
`{info, data}` 形式です。

### `/v1/reports/referrals`(および `/v2/reports/referrals`)

AI の回答に起因する、自社ドメインへの人間による参照トラフィック。

### `/v1/reports/bots`(および `/v2/reports/bots`)

自社ドメインへの AI クローラー / ボットのトラフィック。

### `/v2/reports/factcheck` と `/v2/reports/factcheck/claims`

カテゴリの FactCheck スコアと不正確な主張。これらのエンドポイントは
`category_id`、`start_date`、`end_date` を受け付けますが、`metrics` は受け付けません。

### V2 レポートエンドポイント

`POST /v2/reports/visibility`、`/v2/reports/citations`、
`/v2/reports/sentiment`、`/v2/reports/query-fanouts` は、上記の V1 レポートの V2
版です。包含的な `end_date`、`filter` ツリー、各行の名前付きメトリクスフィールド、
カーソルページネーションを備えています。
`/v2/reports/shopping/*` と `/v2/reports/social/youtube/*` は V2 のみです。
それぞれに `/stream` SSE バリアントがあります。
[フィルタリングと概念](/ja-jp/rest-api/reports/reports-v2-overview) をご覧ください。

## Answers(プロンプトごとのデータ)

| メソッド | パス | 用途 |
| - | - | - |
| `POST` | `/v1/prompts/answers` | カテゴリ内のプロンプトに対する生の AI 回答を取得します。 |
| `POST` | `/v2/prompts/answers` | カテゴリの実行ごとの生の回答行を取得します。 |

## Agents

| メソッド | パス | 用途 |
| - | - | - |
| `GET` | `/v1/agents` | 設定済みのエージェントを一覧表示します。 |
| `GET` | `/v1/agents/{id}` | 1 つのエージェントの設定を取得します。 |
| `POST` | `/v1/agents/{id}/runs` | 新しいエージェント実行を開始します。 |
| `GET` | `/v1/agents/{id}/runs/{run_id}` | 実行のステータスをポーリングします。 |

## Prompts

| メソッド | パス | 用途 |
| - | - | - |
| `GET` | `/v1/org/categories/{id}/prompts` | カテゴリ内のプロンプトを一覧表示します。 |
| `POST` | `/v1/org/categories/{id}/prompts` | プロンプトを追加します。 |
| `PATCH` | `/v1/org/categories/{id}/prompts` | プロンプトを編集します。 |
| `PATCH` | `/v1/org/categories/{id}/prompts/status` | プロンプトを有効化/無効化します。 |

## Content Optimization(ベータ)

| メソッド | パス | 用途 |
| - | - | - |
| `GET` | `/v1/content/{asset_id}/optimization` | アセットの最適化の機会。 |
| `GET` | `/v1/content/{asset_id}/optimization/{content_id}` | 1 つの最適化の詳細。 |

***

正式なパラメータリファレンス(すべての演算子、すべてのフィールド、
必須か任意か)については、[REST API](/ja-jp/rest-api/introduction) タブをご覧ください。