Skip to main content
GET
/
content-gap
/
prompts
List Content Gap Prompts
curl --request GET \
  --url https://server.promptwatch.com/api/v2/content-gap/prompts \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "6ba7b823-9dad-11d1-80b4-00c04fd430c8",
      "prompt": "Best CRM for 50-person services firms?",
      "type": "ORGANIC",
      "intent": "COMMERCIAL",
      "languageCode": "en-US",
      "createdAt": "2026-03-01T10:00:00.000Z",
      "responseCount": 24,
      "latestContentGap": {
        "id": "6ba7b824-9dad-11d1-80b4-00c04fd430c8",
        "score": 0.63,
        "date": "2026-03-28T12:00:00.000Z",
        "sitemapTotalUrls": 500,
        "sitemapCrawledUrls": 412,
        "queryFanoutsCount": 6
      }
    },
    {
      "id": "6ba7b825-9dad-11d1-80b4-00c04fd430c8",
      "prompt": "How does Example Brand compare on integrations?",
      "type": "COMPETITOR_COMPARISON",
      "intent": "INFORMATIONAL",
      "languageCode": "en-US",
      "createdAt": "2026-03-10T15:30:00.000Z",
      "responseCount": 12,
      "latestContentGap": null
    }
  ],
  "total": 222,
  "page": 1,
  "size": 25,
  "totalPages": 9
}

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
​
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

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