Skip to main content
GET
Get topic by platform position heatmap

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

topicId
string<uuid>

Restrict to a single topic id.

days
integer

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

Required range: x >= 1
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"

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

Response

Topic x platform position cells.

Average brand position per topic x platform. The platform axis is the report, so it takes no platform filter.

project
object
required
platforms
string[]
required
cells
object[]
required
dateRange
object
required