Brand Visibility Over Time - Promptwatch API Documentation

Brand Visibility Over Time

curl --request GET \
  --url https://server.promptwatch.com/api/v2/analytics/brands/visibility-over-time \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://server.promptwatch.com/api/v2/analytics/brands/visibility-over-time"

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/analytics/brands/visibility-over-time', 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/analytics/brands/visibility-over-time",
  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/analytics/brands/visibility-over-time"

	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/v2/analytics/brands/visibility-over-time")

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

[
  {
    "date": "2026-03-14",
    "brand": {
      "id": "6ba7b81d-9dad-11d1-80b4-00c04fd430c8",
      "name": "Example Brand",
      "domain": "example.com",
      "relation": "SELF"
    },
    "averageVisibility": 58.2,
    "mentionCount": 42,
    "totalResponses": 55,
    "visibilityPercentage": 76.4
  },
  {
    "date": "2026-03-15",
    "brand": {
      "id": "6ba7b81d-9dad-11d1-80b4-00c04fd430c8",
      "name": "Example Brand",
      "domain": "example.com",
      "relation": "SELF"
    },
    "averageVisibility": 61,
    "mentionCount": 45,
    "totalResponses": 58,
    "visibilityPercentage": 77.6
  }
]

GET

/

analytics

/

brands

/

visibility-over-time

Brand Visibility Over Time

curl --request GET \
  --url https://server.promptwatch.com/api/v2/analytics/brands/visibility-over-time \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://server.promptwatch.com/api/v2/analytics/brands/visibility-over-time"

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/analytics/brands/visibility-over-time', 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/analytics/brands/visibility-over-time",
  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/analytics/brands/visibility-over-time"

	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/v2/analytics/brands/visibility-over-time")

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

[
  {
    "date": "2026-03-14",
    "brand": {
      "id": "6ba7b81d-9dad-11d1-80b4-00c04fd430c8",
      "name": "Example Brand",
      "domain": "example.com",
      "relation": "SELF"
    },
    "averageVisibility": 58.2,
    "mentionCount": 42,
    "totalResponses": 55,
    "visibilityPercentage": 76.4
  },
  {
    "date": "2026-03-15",
    "brand": {
      "id": "6ba7b81d-9dad-11d1-80b4-00c04fd430c8",
      "name": "Example Brand",
      "domain": "example.com",
      "relation": "SELF"
    },
    "averageVisibility": 61,
    "mentionCount": 45,
    "totalResponses": 58,
    "visibilityPercentage": 77.6
  }
]

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 90 days.

endDate

string<date>

End date (YYYY-MM-DD). Max range 90 days.

range

enum<string>

default:daily

Available options:

daily,

weekly,

monthly

models

Filter by LLM models. Repeat for multiple

promptId

string<uuid>

llmMonitorId

string<uuid>

promptTypes

Filter by prompt type. Repeat for multiple

Available options:

ORGANIC,

BRAND_SPECIFIC,

COMPETITOR_COMPARISON

topicIds

Filter by prompt topic IDs. Repeat for multiple: topicIds=x&topicIds=y

limit

integer

Required range: x >= 1

skip

integer

Ranked brands to skip before the limit window. With includeSelf, forced SELF consumes one slot on every page, so skip>0 drops the lowest-ranked brand and SELF repeats.

Required range: x >= 0

excludeSelf

boolean

relations

Filter by brand relation. Repeat for multiple

Available options:

DIRECT_COMPETITOR,

SELF,

IGNORED,

OTHER

query

string

Response

Default Response

date

string

required

Date (YYYY-MM-DD)

brand

object

required

Show child attributes

averageVisibility

number

required

mentionCount

number

required

totalResponses

number

required

visibilityPercentage

number

required

Example:

[
  {
    "date": "2026-03-14",
    "brand": {
      "id": "6ba7b81d-9dad-11d1-80b4-00c04fd430c8",
      "name": "Example Brand",
      "domain": "example.com",
      "relation": "SELF"
    },
    "averageVisibility": 58.2,
    "mentionCount": 42,
    "totalResponses": 55,
    "visibilityPercentage": 76.4
  },
  {
    "date": "2026-03-15",
    "brand": {
      "id": "6ba7b81d-9dad-11d1-80b4-00c04fd430c8",
      "name": "Example Brand",
      "domain": "example.com",
      "relation": "SELF"
    },
    "averageVisibility": 61,
    "mentionCount": 45,
    "totalResponses": 58,
    "visibilityPercentage": 77.6
  }
]

⌘I