Top Competitors - Promptwatch API Documentation

Top Competitors

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

[
  {
    "competitor": "<string>",
    "count": 123,
    "percentage": 123
  }
]

GET

responses

competitors

Top Competitors

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

[
  {
    "competitor": "<string>",
    "count": 123,
    "percentage": 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

competitor

string

required

Competitor name

count

number

required

Number of mentions

percentage

number

required

Percentage of total competitor mentions

⌘I