Skip to main content
GET
/
api
/
v1
/
brands
/
{brandId}
/
prompts
List Prompts
curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId}/prompts \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "prompts": [
    {
      "id": "<string>",
      "text": "<string>",
      "topic": "<string>",
      "type": "<string>",
      "tags": [
        {}
      ],
      "answersCount": 123,
      "mentionRate": 123,
      "sourceRate": 123,
      "lastGeneratedAt": "<string>",
      "competitors": [
        {}
      ],
      "competitorsCount": 123,
      "competitorMentionsTotal": 123,
      "brandMentioned": true,
      "brandMentionCount": 123,
      "sources": [
        {}
      ],
      "sourcesCount": 123,
      "sourceCitationsTotal": 123,
      "sourceStability": 123,
      "createdAt": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.qwairy.co/llms.txt

Use this file to discover all available pages before exploring further.

Prompts are the questions Qwairy monitors across AI platforms. Each prompt is categorized by funnel stage (TOFU/MOFU/BOFU), tagged for organization, and linked to a topic. Track which prompts generate mentions and source citations for your brand.
See Entities for the complete Prompt object structure, and Topic / Tag for classification objects.
​
Authorization
string
required
Bearer token. Example: Bearer qw-api-xxx

​
Path Parameters

​
brandId
string
required
The unique identifier of the brand

​
Query Parameters

​
period
number
Number of days to include. Returns prompts that received at least one answer within the window. If not specified, returns all data.
​
startDate
string
Start date (ISO 8601, e.g. 2026-03-05). Returns prompts with at least one answer on or after this date.
​
endDate
string
End date (ISO 8601, e.g. 2026-03-31). Returns prompts with at least one answer on or before this date.
When a date range is provided, both the prompt list and the per-prompt include=details aggregations (answersCount, competitors[].mentions, brandMentionCount, sources[].citations) are scoped to that window. Prompts that ran multiple times still appear if at least one of their runs falls inside the range.
​
topic
string
Filter by topic ID (keywordId). Supports comma-separated multi-select (e.g., id1,id2).
​
tag
string
Filter by tag ID. Supports comma-separated multi-select (e.g., id1,id2).
​
type
string
Filter by prompt type: TOFU, MOFU, BOFU
​
limit
number
default:"50"
Maximum number of prompts to return (max: 100)
​
offset
number
default:"0"
Pagination offset
​
sort
string
default:"lastGeneratedAt"
Field to sort by: lastGeneratedAt, answersCount, text, createdAt
​
order
string
default:"desc"
Sort order: asc or desc
​
include
string
Set to details to enrich each prompt with aggregated competitors, sources, brand mentions, and source stability metrics. When omitted, the response includes only the base fields listed below.

​
Response

​
success
boolean
Indicates if the request was successful
​
pagination
object
​
prompts
array

​
Example Request

curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/prompts?type=TOFU&limit=10" \
  -H "Authorization: Bearer qw-api-your-token-here"

​
Example Response

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 1,
    "limit": 10,
    "offset": 0
  },
  "prompts": [
    {
      "id": "q1",
      "text": "What are the best products in this category?",
      "topic": "Product Reviews",
      "type": "TOFU",
      "tags": ["reviews", "comparison"],
      "answersCount": 2,
      "mentionRate": 50.0,
      "sourceRate": 25.0,
      "lastGeneratedAt": "2024-12-19T10:00:00.000Z"
    }
  ]
}

​
Example with include=details

curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/prompts?include=details&limit=10" \
  -H "Authorization: Bearer qw-api-your-token-here"

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 1,
    "limit": 10,
    "offset": 0
  },
  "prompts": [
    {
      "id": "q1",
      "text": "What are the best products in this category?",
      "topic": "Product Reviews",
      "type": "TOFU",
      "tags": ["reviews", "comparison"],
      "answersCount": 2,
      "mentionRate": 50.0,
      "sourceRate": 25.0,
      "lastGeneratedAt": "2024-12-19T10:00:00.000Z",
      "competitors": [
        { "name": "My Brand", "mentions": 3, "relationship": "SELF" },
        { "name": "Competitor A", "mentions": 8, "relationship": "DIRECT" },
        { "name": "Competitor B", "mentions": 5, "relationship": "DIRECT" }
      ],
      "competitorsCount": 3,
      "competitorMentionsTotal": 16,
      "brandMentioned": true,
      "brandMentionCount": 3,
      "sources": [
        { "domain": "mybrand.com", "citations": 2, "isSelf": true },
        { "domain": "expert-reviews.com", "citations": 4, "isSelf": false },
        { "domain": "industry-news.com", "citations": 3, "isSelf": false }
      ],
      "sourcesCount": 3,
      "sourceCitationsTotal": 9,
      "sourceStability": 33.33,
      "createdAt": "2024-12-01T10:00:00.000Z"
    }
  ]
}