/api/v2/competitor-heatmapGet competitor visibility heatmap data.
Get competitor visibility heatmap data.
Requires bearer API key
Parameters
X-Project-Id
header
Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.
Schema: string
startDate
query
No description provided.
Schema: string:date-time
endDate
query
No description provided.
Schema: string:date-time
models
query
Comma-separated values are accepted.
Schema: string
monitorIds
query
Comma-separated values are accepted.
Schema: string
brandIds
query
Comma-separated values are accepted.
Schema: string
limit
query
No description provided.
Schema: string
Responses
Successful JSON response.
application/json{
"type": "object",
"additionalProperties": false,
"properties": {
"models": {
"type": "array",
"items": {
"type": "string"
}
},
"competitors": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"domain": {
"type": "string",
"nullable": true
},
"relation": {
"type": "string"
}
},
"required": [
"id",
"name",
"domain",
"relation"
]
}
},
"matrix": {
"type": "object",
"additionalProperties": true
},
"minVisibility": {
"type": "number",
"nullable": true
},
"maxVisibility": {
"type": "number",
"nullable": true
}
},
"required": [
"models",
"competitors",
"matrix",
"minVisibility",
"maxVisibility"
]
}Try it
Send this request to the local WatchLLM REST handler. Use a key from `/workspace/api`; organization keys can include `X-Project-Id` only when the endpoint documents that header.