# Metrics

Aggregated visibility, share of voice, citation and position data for your brand and its competitors, ready to chart. Every endpoint accepts the shared filters and the `output` parameter described in Core Concepts.

### GET `/metrics/timeseries`

Returns time series for one or more metrics, grouped by actor (your project + selected competitors). Weekly/monthly values follow the period semantics above. Optional `prompt_type` (search intent) and `brand_kind` filters scope every metric to a prompt category.

### GET `/metrics/summary`

Aggregates per actor and metric (`total`/`min`/`max`/`last`). Ideal for KPI tiles.

### GET `/metrics/prompt_summary`

Returns paginated per-prompt aggregated metrics (responses, mentions, citations, mention_rate, citation_rate, avg_mention_position, avg_position). Supports `breakdown=model` to add the AI model dimension to each row, returning per-prompt per-model metrics. Params: `sort` (`responses`, `mentions`, `citations`, `mention_rate` or `visibility`, `citation_rate`, `avg_mention_position`, `avg_position`), `sort_dir` (`asc`/`desc`), `breakdown` (`model`), `page`, `per_page` (max 100).

### GET `/metrics/sov`

Share of Voice based on mentions, aligned with Overview.

- **over_time**: for each date, `SOV = (actor_mentions / sum_all_mentions) × 100`. If the daily sum is 0, the last value is carried forward (sticky).
- **current**: uses the latest date with non-zero total; if none, it uses totals over the whole range.
- **breakdown**: top 4 actors + an aggregated _Others_ row (and a detailed `others` list).

### GET `/metrics/top_sources`

Ranks source domains by number of responses and average mention rate (% of executions that surfaced that domain).

- The dataset includes non-rejected sources linked to prompt executions within the window and current filters.
- `total_responses`: number of unique prompt executions that produced at least one source on that domain.
- `avg_mention_rate` (also returned as `avg_visibility`): `(count of source rows for the domain / total executions) × 100`.
- Sorting: `sort=total_responses` (default), `sort=avg_mention_rate`, or `sort=avg_visibility`.
- Pagination: `page` (>=1), `per_page` (default 20, max 100).
- Filter by domain: `query` (case-insensitive `LIKE`), e.g. `query=github.`

Full access. Cancel anytime.
