Skip to main content
GET
/
query-fanouts
List Query Fanouts
curl --request GET \
  --url https://server.promptwatch.com/api/v2/query-fanouts \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "6ba7b828-9dad-11d1-80b4-00c04fd430c8",
      "prompt": "Affordable project management tools for agencies?",
      "type": "ORGANIC",
      "intent": "COMMERCIAL",
      "combinedVolume": 14800,
      "combinedDifficulty": 41,
      "keywords": [
        {
          "id": "6ba7b829-9dad-11d1-80b4-00c04fd430c8",
          "text": "agency project management software",
          "extractedFromChatgpt": true,
          "googleSearchVolume": 1900,
          "bingSearchVolume": 420,
          "aiSearchVolume": 210,
          "googleKeywordDifficulty": 38
        }
      ]
    },
    {
      "id": "6ba7b82a-9dad-11d1-80b4-00c04fd430c8",
      "prompt": "Example Brand vs Contoso for invoicing",
      "type": "COMPETITOR_COMPARISON",
      "intent": "BRANDED",
      "combinedVolume": 3200,
      "combinedDifficulty": 55,
      "keywords": [
        {
          "id": "6ba7b82b-9dad-11d1-80b4-00c04fd430c8",
          "text": "example brand invoicing",
          "extractedFromChatgpt": false,
          "googleSearchVolume": null,
          "bingSearchVolume": null,
          "aiSearchVolume": null,
          "googleKeywordDifficulty": null
        }
      ]
    }
  ],
  "total": 95,
  "page": 1,
  "size": 25,
  "totalPages": 4
}

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