Skip to main content
GET
List Query Fanouts

Authorizations

X-API-Key
string
header
required

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

Query Parameters

page
number
default:1
Required range: x >= 1
size
number
default:25
Required range: 1 <= x <= 100
query
string

Text search on prompt

promptTypes

Prompt type filter; repeat the parameter for multiple values

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
intentTypes

Intent type filter; repeat the parameter for multiple values

Available options:
BRANDED,
INFORMATIONAL,
NAVIGATIONAL,
COMMERCIAL,
TRANSACTIONAL
hasChatgptFanouts
boolean

Filter to prompts with ChatGPT-extracted keywords

promptId

Filter by prompt ID(s). Repeat for multiple: promptId=id1&promptId=id2

sortBy
enum<string>

Sort field (combinedVolume/combinedDifficulty not supported - computed post-query)

Available options:
createdAt,
updatedAt,
type,
intent
sortOrder
enum<string>
Available options:
asc,
desc

Response

Default Response

items
object[]
required

Page of prompts

page
integer
required

Page number (1-based)

size
integer
required

Page size

total
integer
required

Total items matching the request

totalPages
integer
required

Total pages for this page size