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

# Endpoints at a glance

> Every Profound API endpoint, its key metrics/dimensions/filters, and what it's for — one scannable page.

Orient yourself in 30 seconds. Each row is one endpoint; click through
for the full parameter reference. For deeper context on conventions
(dates, ordering, pagination), see [Conventions & gotchas](/cookbook/setup/conventions).

## Organization & setup

| Method | Path                               | Use it for                                             |
| ------ | ---------------------------------- | ------------------------------------------------------ |
| `GET`  | `/v1/org/categories`               | List every category your key can see.                  |
| `GET`  | `/v1/org/categories/{id}/assets`   | Assets in a category, with `is_owned` + domains.       |
| `GET`  | `/v1/org/categories/{id}/topics`   | Configured topics for the category.                    |
| `GET`  | `/v1/org/categories/{id}/tags`     | Configured tags.                                       |
| `GET`  | `/v1/org/categories/{id}/personas` | Configured personas.                                   |
| `GET`  | `/v1/org/regions`                  | Regions enabled on your org.                           |
| `GET`  | `/v1/org/models`                   | AI models (ChatGPT, Claude, etc.) enabled on your org. |
| `GET`  | `/v1/org/domains`                  | Domains your org owns.                                 |
| `GET`  | `/v1/org/personas`                 | Personas enabled on your org.                          |

## Reports

All report endpoints are `POST`, scoped by `category_id`, and return the
same `{info, data}` shape. Required body fields: `category_id`,
`start_date`, `end_date`, `metrics`. Optional: `dimensions`,
`date_interval`, `filters`, `pagination`, `order_by`.

### `/v1/reports/visibility`

How often your asset appears in AI answers.

| Metrics                                                                                  | Dimensions                                                         | Common filters                                                            |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| `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` |

Common recipes: [Visibility Score (with delta)](/cookbook/visibility/asset-visibility-score),
[over time](/cookbook/visibility/visibility-over-time),
[leaderboard](/cookbook/visibility/leaderboard),
[compare competitors](/cookbook/visibility/compare-competitors),
[segment by model/region/persona](/cookbook/visibility/segment-by-model).

### `/v1/reports/citations`

Which URLs and domains AI answers cite.

| Metrics                   | Dimensions                                                                      | Common filters                                                             |
| ------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `count`, `citation_share` | `date`, `root_domain`, `url`, `citation_category`, `model`, `region`, `persona` | `prompt_type` (e.g. `"visibility"`), `model_id`, `region_id`, `persona_id` |

Common recipes: [Citation Share + delta](/cookbook/citations/citation-share),
[share + volume over time](/cookbook/citations/citation-share-over-time),
[rank by domain](/cookbook/citations/top-citing-domains).

<Note>
  `citation_share` is per-AI-model averaged. `count` is the raw number.
  Sorting by one doesn't track the other — pick the question you're
  answering and sort on the matching metric.
</Note>

### `/v1/reports/sentiment`

How positively/negatively AI answers reference your asset.

| Metrics                               | Dimensions                                                                             | Common filters                                                           |
| ------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `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>
  Numbers from the current public sentiment endpoint will not match the
  Profound app's headline value exactly. Sentiment v2 — which closes the
  gap — is releasing soon.
</Warning>

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

The query-fanout view (how prompts cascade across AI surfaces). Same
`{info, data}` shape.

### `/v1/reports/referrals` (and `/v2/reports/referrals`)

Human-referral traffic to your domains attributed back to AI answers.

### `/v1/reports/bots` (and `/v2/reports/bots`)

AI crawler / bot traffic to your domains.

## Answers (per-prompt data)

| Method | Path                  | Use it for                                      |
| ------ | --------------------- | ----------------------------------------------- |
| `POST` | `/v1/prompts/answers` | Fetch raw AI answers for prompts in a category. |

## Agents

| Method | Path                            | Use it for              |
| ------ | ------------------------------- | ----------------------- |
| `GET`  | `/v1/agents`                    | List configured agents. |
| `GET`  | `/v1/agents/{id}`               | Get one agent's config. |
| `POST` | `/v1/agents/{id}/runs`          | Start a new agent run.  |
| `GET`  | `/v1/agents/{id}/runs/{run_id}` | Poll a run's status.    |

## Prompts

| Method  | Path                                     | Use it for                  |
| ------- | ---------------------------------------- | --------------------------- |
| `GET`   | `/v1/org/categories/{id}/prompts`        | List prompts in a category. |
| `POST`  | `/v1/org/categories/{id}/prompts`        | Add a prompt.               |
| `PATCH` | `/v1/org/categories/{id}/prompts`        | Edit prompts.               |
| `PATCH` | `/v1/org/categories/{id}/prompts/status` | Enable/disable prompts.     |

## Content Optimization

| Method | Path                                               | Use it for                               |
| ------ | -------------------------------------------------- | ---------------------------------------- |
| `GET`  | `/v1/content/{asset_id}/optimization`              | Optimization opportunities for an asset. |
| `GET`  | `/v1/content/{asset_id}/optimization/{content_id}` | One optimization in detail.              |

***

For the canonical parameter reference (every operator, every field,
required vs optional), see the [REST API](/rest-api/introduction) tab.