Skip to main content
GET
/
share-of-voice
/
comparison
Share of Voice Comparison
curl --request GET \
  --url https://server.promptwatch.com/api/v1/share-of-voice/comparison \
  --header 'X-API-Key: <api-key>'
{
  "current": {
    "totalResponses": 123,
    "brandMentions": 123,
    "shareOfVoice": 123
  },
  "previous": {
    "totalResponses": 123,
    "brandMentions": 123,
    "shareOfVoice": 123
  },
  "change": 123,
  "changePercent": 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)

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

current
object
required
previous
object
required
change
number
required

Percentage point change between periods

changePercent
number
required

Relative percentage change between periods