v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB

Basics

Get Prompts

Returns all prompts for a specific website. You can optionally filter by status (active or paused). The prompts returned include metadata such as monthly search volume and total value.

get/api/v1/prompts

Query parameters

website_idstring uuid required

The ID of the website to retrieve prompts for

status'active' | 'paused'

Filter prompts by status. If omitted, returns both active and paused prompts.

prompt_tagsstring[]

Filter prompts by tag. Pass one or more prompt tag IDs (UUIDs). When omitted, prompts are not filtered by tag. Combine with prompt_tags_operator to control how multiple tags are matched. All tag IDs must belong to the same website as website_id, otherwise the request is rejected with 403.

prompt_tags_operator'is_any_of' | 'has_all_of'

How to combine the prompt_tags filter. is_any_of (default) returns prompts carrying at least one of the given tags; has_all_of returns only prompts carrying every given tag. Ignored when prompt_tags is omitted.

Response

Successful response with list of prompts

Example response

{
  "prompts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "prompt": "How to optimize website performance",
      "topic_name": "Web Development",
      "current_monthly_searches": 5400,
      "current_total_value": 1250.5,
      "status": "active",
      "country": "United States",
      "countries": [
        {
          "country": "United States",
          "is_primary": true
        },
        {
          "country": "Canada",
          "is_primary": false
        }
      ],
      "tags": [
        {
          "id": "223e4567-e89b-12d3-a456-426614174111",
          "name": "Caption Phones"
        }
      ]
    }
  ]
}