Skip to main content
GET
/
api
/
v1
/
brands
/
{brandId}
/
social
Social Signals
curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId}/social \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "social": [
    {
      "id": "<string>",
      "platform": "<string>",
      "communityId": "<string>",
      "communityName": "<string>",
      "url": "<string>",
      "title": "<string>",
      "domain": "<string>",
      "position": 123,
      "upvotes": 123,
      "commentCount": 123,
      "createdAt": "<string>"
    }
  ]
}
Track citations from social platforms (Reddit, YouTube, Twitter, forums) in AI responses. Understand which social content AI platforms reference when answering questions about your industry.

​
List Social Insights

​
Authorization
string
required
Bearer token. Example: Bearer qw-api-xxx
GET /api/v1/brands/{brandId}/social

​
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).
​
platform
string
Filter by platform: reddit, youtube, twitter, facebook, linkedin, other
​
limit
number
default:"50"
Maximum number of citations to return (max: 100)
​
offset
number
default:"0"
Number of results to skip for pagination
​
sort
string
default:"createdAt"
Field to sort by: createdAt, position, upvotes, comments, url
​
order
string
default:"desc"
Sort order: asc or desc

​
Response

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

​
Example Request

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

​
Example Response

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 2,
    "limit": 10,
    "offset": 0
  },
  "social": [
    {
      "id": "soc1",
      "platform": "reddit",
      "communityId": "SaaS",
      "communityName": "r/SaaS",
      "url": "https://reddit.com/r/SaaS/comments/abc123/best_crm_tools",
      "title": "Best CRM tools for startups in 2024?",
      "domain": "reddit.com",
      "position": 2,
      "upvotes": 245,
      "commentCount": 89,
      "createdAt": "2024-12-15T10:30:00Z"
    },
    {
      "id": "soc2",
      "platform": "youtube",
      "communityId": "TechReviewer",
      "communityName": "TechReviewer",
      "url": "https://youtube.com/@TechReviewer/crm-comparison",
      "title": "CRM Software Comparison 2024",
      "domain": "youtube.com",
      "position": 3,
      "upvotes": 0,
      "commentCount": 0,
      "createdAt": "2024-12-14T15:45:00Z"
    }
  ]
}
Social signals like upvotes and comments are only available for platforms that expose this data (primarily Reddit). Other platforms may show 0 for these fields.

​
Error Responses

StatusCodeDescription
401INVALID_TOKENAuthentication failed
404BRAND_NOT_FOUNDBrand doesn’t exist or not accessible