List Source Domains

Monitor which domains AI platforms cite

GET /api/v1/brands/{brandId}/source-domains

List Source Domains

cURL

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

200

{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "sources": [
    {
      "id": "<string>",
      "domain": "<string>",
      "type": "<string>",
      "isSelf": true,
      "totalMentions": 123,
      "rate": 123,
      "avgPosition": 123
    }
  ]
}

Track which websites AI platforms cite when answering questions about your industry. Identify opportunities to get your content cited, and monitor which sources influence AI responses in your space.

See Entities for the complete Source object structure.

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).

type · string

Filter by source type: INSTITUTIONAL, COMMERCIAL, MEDIA, BLOG, etc.

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).

limit · number · default: "50"

Maximum number of sources to return (max: 100)

offset · number · default: "0"

Number of results to skip for pagination

sort · string · default: "mentions"

Field to sort by: mentions, position, rate, domain

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 sources matching filters

count · number

Number of sources in this response

limit · number

Maximum items per page

offset · number

Number of items skipped

sources · array

Show Source object

id · string

Source ID

domain · string

Domain name

type · string

Source type

isSelf · boolean

Whether this is your own domain

totalMentions · number

Total citation count

rate · number

Share of Citations (%) - percentage of all citations from this source

avgPosition · number

Average position in source lists

Example Request

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

Example Response

{
  "success": true,
  "pagination": {
    "total": 45,
    "count": 2,
    "limit": 10,
    "offset": 0
  },
  "sources": [
    {
      "id": "src1",
      "domain": "industry-news.com",
      "type": "MEDIA",
      "isSelf": false,
      "totalMentions": 102,
      "rate": 5.10,
      "avgPosition": 3.2
    },
    {
      "id": "src2",
      "domain": "mybrand.com",
      "type": "INSTITUTIONAL",
      "isSelf": true,
      "totalMentions": 45,
      "rate": 2.25,
      "avgPosition": 2.1
    }
  ]
}