Answers are the AI-generated responses to your monitored prompts. Each answer includes the full text, detected brand mentions with position and sentiment, cited sources, and relevance scores. Filter by provider, topic, or presence of brand mentions.
List Answers Bearer token. Example: Bearer qw-api-xxx
GET /api/v1/brands/{brandId}/answers
Path Parameters The unique identifier of the brand
Query Parameters Number of days to include. If not specified, returns all data.
Start date (ISO 8601 format)
End date (ISO 8601 format)
Filter by AI provider: chatgpt, perplexity, claude, gemini, etc.
Filter by prompt type: TOFU, MOFU, BOFU
Filter by presence of brand mention: true or false
Filter by presence of brand source citation: true or false
Maximum number of answers to return (max: 100)
sort
string
default: "createdAt"
Field to sort by: createdAt
Response Indicates if the request was successful
Total number of answers matching filters
Number of answers in this response
First 200 characters of the response
Whether brand is mentioned
Position in mention list (if mentioned)
Whether brand domain is cited
Number of competitors mentioned
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 , "relevance" : 75 , "createdAt" : "2024-12-19T10:00:00.000Z" } ] }
Get Answer Details Retrieve the complete response with full text and detailed analysis.
GET /api/v1/brands/{brandId}/answers/{answerId}
Path Parameters The unique identifier of the brand
The unique identifier of the answer
Response Indicates if the request was successful
Associated prompt info (id, text, topic, type)
List of mentioned competitors with position, relationship, sentiment, and relevance
List of cited sources with URL, domain, position, and isSelf flag
Example Request curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/answers/ans1" \ -H "Authorization: Bearer qw-api-your-token-here"
Example Response { "success" : true , "answer" : { "id" : "ans1" , "prompt" : { "id" : "q1" , "text" : "What are the best products in this category?" , "topic" : "Product Reviews" , "type" : "TOFU" }, "provider" : "ChatGPT" , "model" : "GPT-4o" , "text" : "Based on recent reviews and comparisons, several products stand out in this category. My Brand offers one of the best solutions with excellent performance and user ratings. Competitor A also provides a strong alternative..." , "competitors" : [ { "name" : "My Brand" , "position" : 3 , "relationship" : "SELF" , "sentiment" : 85 , "relevance" : 78 }, { "name" : "Competitor A" , "position" : 1 , "relationship" : "DIRECT" , "sentiment" : 80 , "relevance" : 82 } ], "sources" : [ { "url" : "https://industry-news.com/product-comparison" , "domain" : "industry-news.com" , "position" : 1 , "isSelf" : false }, { "url" : "https://mybrand.com/products" , "domain" : "mybrand.com" , "position" : 2 , "isSelf" : true } ], "sentiment" : 82 , "relevance" : 75 , "createdAt" : "2024-12-19T10:00:00.000Z" } }
Error Responses Status Code Description 400 INVALID_PARAMETERInvalid query parameter 401 INVALID_TOKENAuthentication failed 404 BRAND_NOT_FOUNDBrand doesn’t exist or not accessible 404 ANSWER_NOT_FOUNDAnswer doesn’t exist
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
