curl -X GET 'https://server.example.com/api/v2/competitor-heatmap?startDate=2026-04-20&endDate=2026-05-19&limit=20&hideIgnoredBrands=true' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'X-Project-Id: YOUR_PROJECT_ID'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://server.promptwatch.com/api/v2/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/v2/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/v2/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))

}

HttpResponse<String> response = Unirest.get("https://server.promptwatch.com/api/v2/competitor-heatmap")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.promptwatch.com/api/v2/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-4.1",
    "anthropic/claude-sonnet-4-20250514"
  ],
  "competitors": [
    {
      "name": "Example Brand",
      "domain": "example.com",
      "relation": "SELF"
    },
    {
      "name": "Contoso Insights",
      "domain": "contoso.example",
      "relation": "DIRECT_COMPETITOR"
    }
  ],
  "matrix": {
    "Contoso Insights": {
      "openai/gpt-4.1": 38.5,
      "anthropic/claude-sonnet-4-20250514": 41.2
    },
    "Example Brand": {
      "openai/gpt-4.1": 62,
      "anthropic/claude-sonnet-4-20250514": 58.75
    }
  },
  "minVisibility": 38.5,
  "maxVisibility": 62
}

{
  "error": "Bad Request",
  "code": "DATE_RANGE_TOO_LARGE",
  "message": "Date range cannot exceed 90 days"
}

{
  "error": "Unauthorized",
  "message": "Missing or invalid X-API-Key header."
}

{
  "error": "Unauthorized",
  "message": "Missing or invalid X-API-Key header."
}