Skip to main content
GET
List Prompt Brand Ranks

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 (YYYY-MM-DD). Defaults to 29 days before today (30 days including today). Max range 90 days.

endDate
string<date>

End date (YYYY-MM-DD). Defaults to today. Max range 90 days.

page
integer
default:1

Page number (1-based)

Required range: x >= 1
size
integer
default:25

Page size

Required range: 1 <= x <= 100
llmMonitorId
string<uuid>

Filter by monitor

types

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

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
models

Only rank brands using responses from these LLM models. Repeat for multiple: models=x&models=y

query
string

Search query for prompt text

sortOrder
enum<string>
default:desc

Order prompts by average visibility

Available options:
asc,
desc

Response

Default Response

prompts
object[]
required

Active prompts with their ranked brands

total
integer
required

Total items matching the request

page
integer
required

Page number (1-based)

size
integer
required

Page size

totalPages
integer
required

Total pages for this page size