Competitor Visibility Heatmap

curl --request GET \
  --url https://server.promptwatch.com/api/v1/competitor-heatmap \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://server.promptwatch.com/api/v1/competitor-heatmap', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://server.promptwatch.com/api/v1/competitor-heatmap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://server.promptwatch.com/api/v1/competitor-heatmap"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://server.promptwatch.com/api/v1/competitor-heatmap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "models": [
    "openai_gpt-4o",
    "anthropic_claude-3.5-sonnet"
  ],
  "competitors": [
    {
      "name": "Competitor A",
      "domain": "competitor-a.com",
      "relation": "DIRECT_COMPETITOR"
    },
    {
      "name": "Competitor B",
      "domain": "competitor-b.com",
      "relation": "OTHER"
    }
  ],
  "matrix": {
    "Competitor A": {
      "openai_gpt-4o": 45.5,
      "anthropic_claude-3.5-sonnet": 32.1
    },
    "Competitor B": {
      "openai_gpt-4o": 28.3,
      "anthropic_claude-3.5-sonnet": 51.2
    }
  },
  "minVisibility": 28.3,
  "maxVisibility": 51.2
}

GET

competitor-heatmap

Competitor Visibility Heatmap

curl --request GET \
  --url https://server.promptwatch.com/api/v1/competitor-heatmap \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://server.promptwatch.com/api/v1/competitor-heatmap', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://server.promptwatch.com/api/v1/competitor-heatmap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://server.promptwatch.com/api/v1/competitor-heatmap"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://server.promptwatch.com/api/v1/competitor-heatmap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "models": [
    "openai_gpt-4o",
    "anthropic_claude-3.5-sonnet"
  ],
  "competitors": [
    {
      "name": "Competitor A",
      "domain": "competitor-a.com",
      "relation": "DIRECT_COMPETITOR"
    },
    {
      "name": "Competitor B",
      "domain": "competitor-b.com",
      "relation": "OTHER"
    }
  ],
  "matrix": {
    "Competitor A": {
      "openai_gpt-4o": 45.5,
      "anthropic_claude-3.5-sonnet": 32.1
    },
    "Competitor B": {
      "openai_gpt-4o": 28.3,
      "anthropic_claude-3.5-sonnet": 51.2
    }
  },
  "minVisibility": 28.3,
  "maxVisibility": 51.2
}

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 for heatmap data (YYYY-MM-DD)

endDate

string<date>

End date for heatmap data (YYYY-MM-DD)

model

string

Filter by specific LLM model

promptId

string<uuid>

Filter by specific prompt ID

llmMonitorId

string<uuid>

Filter by specific LLM monitor ID

limit

integer

Maximum number of competitors to include (default: 50)

Required range: 1 <= x <= 100

excludeSelf

boolean

Exclude self brand from results (default: false)

hideIgnoredBrands

boolean

Hide ignored brands from results (default: true)

Response

Default Response

models

string[]

required

Ordered list of model identifiers

competitors

object[]

required

Ordered list of competitor information

Show child attributes

matrix

object

required

Matrix of visibility percentages: matrix[competitor][model] = percentage

Show child attributes

minVisibility

number | null

required

Minimum visibility value in the matrix, or null if no data

maxVisibility

number | null

required

Maximum visibility value in the matrix, or null if no data

⌘I

Overview

API Reference

Changelog

Competitor Visibility Heatmap

Authorizations

Query Parameters

Response