Skip to main content
GET
Topics by models, win rate

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

startDate
string<date>

Start date (YYYY-MM-DD). Max range 92 days. Defaults to today.

endDate
string<date>

End date (YYYY-MM-DD). Max range 92 days. Defaults to today.

rowAxis
enum<string>
default:brands

Row dimension. Defaults to brands. Must differ from columnAxis.

Available options:
brands,
models,
topics,
countries
columnAxis
enum<string>
default:models

Column dimension. Defaults to models. Must differ from rowAxis.

Available options:
brands,
models,
topics,
countries
metric
enum<string>
default:visibility

Cell metric. visibility, shareOfVoice, and winRate are 0–100. sentiment is an average score. position is an average rank where 1 is best. Defaults to visibility.

Available options:
visibility,
sentiment,
position,
shareOfVoice,
winRate
models

Filter by model ids from GET /models. Repeat for multiple: models=x&models=y

promptId
string<uuid>

Limit the grid to one prompt. When set, llmMonitorId is ignored.

llmMonitorId
string<uuid>

Filter by one monitor. Ignored when promptId is set.

excludeSelf
boolean
default:false

Drop the project's own brand before the brand limit is applied.

hideIgnoredBrands
boolean
default:true

Hide ignored brands unless relations includes IGNORED.

relations

Brand relations to include. Used when brands is an axis, and for shareOfVoice even when brands is not an axis. Repeat for multiple.

Available options:
DIRECT_COMPETITOR,
SELF,
OTHER,
IGNORED
limit
integer
default:20

Max brands or topics. Models and countries are never capped. Defaults to 20.

Required range: 1 <= x <= 20
promptTypes

Filter by prompt type. Repeat for multiple.

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
tagIds

Filter by prompt tag ids. Repeat for multiple.

topicIds

Filter by prompt topic ids. Repeat for multiple.

Response

Default Response

rowAxis
enum<string>
required
Available options:
brands,
models,
topics,
countries
columnAxis
enum<string>
required
Available options:
brands,
models,
topics,
countries
metric
enum<string>
required
Available options:
visibility,
sentiment,
position,
shareOfVoice,
winRate
brand
object | null
required

The project's own brand when neither axis is brands. Every cell is this brand's value. Null when brands is an axis.

rows
object[]
required
columns
object[]
required
cells
object[]
required

One entry per value. A missing row and column pair means there is no value, not zero.