Skip to main content
GET
/
share-of-voice
/
time-series
Share of Voice Time Series
curl --request GET \
  --url https://server.promptwatch.com/api/v1/share-of-voice/time-series \
  --header 'X-API-Key: <api-key>'
[
  {
    "date": "2023-11-07T05:31:56Z",
    "totalResponses": 123,
    "brandMentions": 123,
    "shareOfVoice": 123,
    "previousPeriodShareOfVoice": 123,
    "change": 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 for share of voice data (YYYY-MM-DD)

​
endDate
string<date>

End date for share of voice data (YYYY-MM-DD)

​
range
enum<string>
default:day

Time grouping for the data (day, week, or month)

Available options:
day,
week,
month
​
model
string

Filter by specific LLM model

​
promptId
string

Filter by specific prompt ID

​
llmMonitorId
string

Filter by specific LLM monitor ID

Response

Default Response

​
date
string<date-time>
required

Start of the period (day, week, or month)

​
totalResponses
number
required

Total organic responses in this period

​
brandMentions
number
required

Responses mentioning your brand in this period

​
shareOfVoice
number
required

Percentage (0-100) of brand mentions vs total organic responses

​
previousPeriodShareOfVoice
number | null

Share of voice in the previous period

​
change
number | null

Percentage point change from previous period