Skip to main content
GET
Prompt Visibility Time Series

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 visibility data (YYYY-MM-DD)

endDate
string<date>

End date for visibility data (YYYY-MM-DD)

range
enum<string>
default:day

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

Available options:
day,
week,
month
models

Filter by LLM models. Repeat for multiple: models=x&models=y

llmMonitorId
string

Filter by specific LLM monitor ID

types

Filter by prompt types. Repeat for multiple: types=x&types=y

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
tagIds

Filter by prompt tag IDs. Repeat for multiple: tagIds=x&tagIds=y

topicIds

Filter by prompt topic IDs. Repeat for multiple: topicIds=x&topicIds=y

sortDirection
enum<string>
default:desc

Direction to rank prompts by average visibility

Available options:
asc,
desc
limit
integer

Number of top-ranked prompts to return (omit for all prompts)

Required range: x >= 1
offset
integer

Number of top-ranked prompts to skip before applying limit

Required range: x >= 0

Response

Default Response

timeSeries
object[]
required

Per-prompt visibility lines, one point per (prompt, bucket)

prompts
object[]
required

Per-prompt summary across the full range, ranked by average visibility

totalPrompts
integer
required

Total number of prompts matching the filters (ignores limit/offset), for pagination