Skip to main content
GET
List Content Gap Prompts

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
query
string

Free-text filter on prompt text

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
tagIds

Filter by prompt tag IDs. Matches prompts with any of the given tags (OR). Repeat for multiple: tagIds=uuid1&tagIds=uuid2

topicIds

Filter by prompt topic IDs. Matches prompts with any of the given topics (OR). Repeat for multiple: topicIds=uuid1&topicIds=uuid2

hasCoverage
boolean

When true, only prompts with a coverage score

sortBy
enum<string>

Sort field

Available options:
contentCoverageScore,
createdAt
sortOrder
enum<string>

Sort direction

Available options:
asc,
desc
startDate
string<date>

Latest gap per prompt is chosen only among runs with createdAt on or after this day (UTC).

endDate
string<date>

Latest gap per prompt is chosen only among runs with createdAt on or before this day (UTC).

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