Skip to main content
GET
/
analytics
/
brands
/
visibility-over-time
Brand Visibility Over Time
curl --request GET \
  --url https://server.promptwatch.com/api/v1/analytics/brands/visibility-over-time \
  --header 'X-API-Key: <api-key>'
[
  {
    "date": "<string>",
    "brand": {
      "id": "<string>",
      "name": "<string>",
      "domain": "<string>",
      "relation": "DIRECT_COMPETITOR"
    },
    "averageVisibility": 123,
    "mentionCount": 123,
    "totalResponses": 123,
    "visibilityPercentage": 123
  }
]

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)

​
endDate
string<date>

End date (YYYY-MM-DD)

​
range
enum<string>
default:daily
Available options:
daily,
weekly,
monthly
​
model
string
​
promptId
string<uuid>
​
llmMonitorId
string<uuid>
​
promptTypes
enum<string>[]

Filter by prompt type

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
​
limit
integer
Required range: x >= 1
​
skip
integer
Required range: x >= 0
​
excludeSelf
boolean
​
relations
enum<string>[]
Available options:
DIRECT_COMPETITOR,
SELF,
IGNORED,
OTHER
​
query
string

Response

Default Response

​
date
string
required

Date (YYYY-MM-DD)

​
brand
object
required
​
averageVisibility
number
required
​
mentionCount
number
required
​
totalResponses
number
required
​
visibilityPercentage
number
required