WWatchLLM
get/api/v2/competitor-heatmap

Get competitor visibility heatmap data.

Get competitor visibility heatmap data.

Requires bearer API key

Parameters

NameInDescription
X-Project-IdheaderRequired for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.string
startDatequeryNo description provided.string:date-time
endDatequeryNo description provided.string:date-time
modelsqueryComma-separated values are accepted.string
monitorIdsqueryComma-separated values are accepted.string
brandIdsqueryComma-separated values are accepted.string
limitqueryNo description provided.string

Responses

200

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.