Skip to main content
GET
List Prompts With Ads

Authorizations

X-API-Key
string
header
required

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

Query Parameters

page
integer
default:1

Page number (1-based)

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

Page size

Required range: 1 <= x <= 100

Search within prompt text

from
string<date-time>

Filter ads captured from this date (ISO 8601)

until
string<date-time>

Filter ads captured until this date (ISO 8601)

models

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

promptTypes

Filter by prompt type. Repeat for multiple values.

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
intentTypes

Filter by prompt intent. Repeat for multiple values.

Available options:
BRANDED,
INFORMATIONAL,
NAVIGATIONAL,
COMMERCIAL,
TRANSACTIONAL
domains

Filter by advertiser root domain. Repeat for multiple values.

Response

Default Response

prompts
object[]
required

Prompts with ads for the current page

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