Response Summary - Promptwatch API Documentation

Response Summary

curl --request GET \
  --url https://server.promptwatch.com/api/v1/responses/summary \
  --header 'X-API-Key: <api-key>'

{
  "totalResponses": 123,
  "totalBrandMentions": 123,
  "brandMentionRate": 123
}

GET

responses

summary

Response Summary

curl --request GET \
  --url https://server.promptwatch.com/api/v1/responses/summary \
  --header 'X-API-Key: <api-key>'

{
  "totalResponses": 123,
  "totalBrandMentions": 123,
  "brandMentionRate": 123
}

X-API-Key

string

header

required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

startDate

string<date>

Start date for data (YYYY-MM-DD)

endDate

string<date>

End date for data (YYYY-MM-DD)

Default Response

totalResponses

number

required

Total number of LLM responses

totalBrandMentions

number

required

Total responses mentioning your brand

brandMentionRate

number

required

Percentage of responses mentioning your brand

⌘I