Mentions Time Series - Promptwatch API Documentation

Mentions Time Series

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

[
  {
    "date": "2023-11-07T05:31:56Z",
    "brandMentions": 123,
    "competitorMentions": 123
  }
]

GET

responses

mentions-time-series

Mentions Time Series

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

[
  {
    "date": "2023-11-07T05:31:56Z",
    "brandMentions": 123,
    "competitorMentions": 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)

range

enum<string>

default:day

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

Available options:

day,

week,

month

llmMonitorId

string

Filter by specific LLM monitor ID

Default Response

date

string<date-time>

required

Date of the data point

brandMentions

number | null

Number of brand mentions

competitorMentions

number | null

Number of competitor mentions

⌘I