Skip to main content
GET
Get per-topic visibility

Authorizations

Authorization
string
header
required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Query Parameters

days
integer

Lookback window in days. Default and maximum vary by endpoint — see the operation description.

Required range: x >= 1
unbranded
enum<string>

Pass true to restrict every metric to non-branded prompts only.

Available options:
true
branded
enum<string>

Pass true to restrict every metric to branded prompts only.

Available options:
true
compare
enum<string>

Period comparison. previous_period re-runs the same metrics over the window immediately before the current one (same length); previous_year over the same window shifted back exactly 365 days. The response gains an additive comparison block: { mode, dateRange, previous, delta }delta is current minus previous for every shared numeric metric (on /visibility/topics, per-topic deltas ride inline on each topic row instead). Invalid values return 400 invalid_argument.

Available options:
previous_period,
previous_year
from
string

Start of an absolute window (inclusive, UTC). Accepts YYYY-MM-DD or a full ISO timestamp. Requires to, and is mutually exclusive with days — sending both returns 400 invalid_argument. A range longer than the endpoint's maximum is rejected rather than clamped.

Example:

"2026-03-01"

to
string

End of an absolute window (inclusive, UTC). Accepts YYYY-MM-DD or a full ISO timestamp. Requires from.

Example:

"2026-03-31"

Response

Per-topic visibility.

project
object
required
topics
object[]
required
dateRange
object
required

The resolved lookback window for this response.

comparison
object

Present only when compare was passed. This surface is report-anchored: the block records the previous window and whether it had a completed report; the per-topic deltas ride INLINE on each topic row's comparison.