List Answers

Retrieve AI-generated responses with filters for provider, brand mentions, and sources

GET /api/v1/brands/{brandId}/answers

List Answers

cURL

curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId}/answers \
  --header 'Authorization: <authorization>'

200

{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "answers": [
    {
      "id": "<string>",
      "promptId": "<string>",
      "promptText": "<string>",
      "provider": "<string>",
      "model": "<string>",
      "textPreview": "<string>",
      "hasSelfMention": true,
      "selfMentionPosition": 123,
      "hasSelfSource": true,
      "competitorsCount": 123,
      "sourcesCount": 123,
      "sentiment": 123,
      "createdAt": "<string>"
    }
  ]
}

Answers are the AI-generated responses to your monitored prompts. Each answer includes the full text, detected brand mentions with position and sentiment, and cited sources. Filter by provider, topic, or presence of brand mentions.

See Entities for the complete Answer object structure, including CompetitorMention and SourceCitation details.

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. If not specified, returns all data.

startDate · string

Start date (ISO 8601 format)

endDate · string

End date (ISO 8601 format)

provider · string

Filter by AI provider. Supports comma-separated multi-select (e.g., chatgpt,claude).

topic · string

Filter by topic ID. 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

hasSelfMention · boolean

Filter by presence of brand mention: true or false

hasSelfSource · boolean

Filter by presence of brand source citation: true or false

limit · number · default: "50"

Maximum number of answers to return (max: 100)

offset · number · default: "0"

Pagination offset

sort · string · default: "createdAt"

Field to sort by: createdAt

order · string · default: "desc"

Sort order: asc or desc

Response

success · boolean

Indicates if the request was successful

pagination · object

Show Pagination info

total · number

Total number of answers matching filters

count · number

Number of answers in this response

limit · number

Maximum items per page

offset · number

Number of items skipped

answers · array

Show Answer summary

id · string

Answer ID

promptId · string

Associated prompt ID

promptText · string

Associated prompt text

provider · string

AI provider name

model · string

AI model name

textPreview · string

First 200 characters of the response

hasSelfMention · boolean

Whether brand is mentioned

selfMentionPosition · number

Position in mention list (if mentioned)

hasSelfSource · boolean

Whether brand domain is cited

competitorsCount · number

Number of competitors mentioned

sourcesCount · number

Number of sources cited

sentiment · number

Sentiment score (0-100)

createdAt · string

Generation timestamp (ISO 8601)

Example Request

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

Example Response

{
  "success": true,
  "pagination": {
    "total": 312,
    "count": 1,
    "limit": 10,
    "offset": 0
  },
  "answers": [
    {
      "id": "ans1",
      "promptId": "q1",
      "promptText": "What are the best products in this category?",
      "provider": "ChatGPT",
      "model": "GPT-4o",
      "textPreview": "Based on recent reviews and comparisons, several products stand out in this category. My Brand offers one of the best solutions...",
      "hasSelfMention": true,
      "selfMentionPosition": 3,
      "hasSelfSource": false,
      "competitorsCount": 5,
      "sourcesCount": 3,
      "sentiment": 82,
      "createdAt": "2024-12-19T10:00:00.000Z"
    }
  ]
}

Filtering Tips

Find answers where you’re mentioned

GET /api/v1/brands/{brandId}/answers?hasSelfMention=true

Find answers where your content is cited

GET /api/v1/brands/{brandId}/answers?hasSelfSource=true

Combine filters for specific insights

# ChatGPT responses where brand is mentioned but not cited
GET /api/v1/brands/{brandId}/answers?provider=chatgpt&hasSelfMention=true&hasSelfSource=false