List Sources (by root domain)

Returns the top cited sources for a website, grouped by root domain. Each row carries citation, mention, brand-mention, and impression metrics for the requested date range, plus a default_source_type classification (owned / competitor / partner / third_party).

Companion to POST /api/v1/source-pages, which returns the same data grouped per URL (one row per cited page) instead of per root domain.

Request body

website_idstring uuid required

The website to list sources for.

page_numinteger

Zero-indexed page number.

page_sizeinteger

Number of rows per page (1–100).

Column to sort by.

sort_direction'asc' | 'desc'

searchstring nullable

Substring filter on normalized_root_domain. Protocol (https://), www., path, query, and fragment are stripped before matching, so a full URL like https://www.example.com/foo collapses to example.com.

mentioned'yes' | 'no'

If yes, only count sources where your brand was mentioned in the citing response. If no, only count sources where your brand was NOT mentioned. Omit the field to count every cited source.

competitors_mentioned'yes' | 'no'

If yes, only count sources where your brand was mentioned in the citing response. If no, only count sources where your brand was NOT mentioned. Omit the field to count every cited source.

Example request

{
  "website_id": "123e4567-e89b-12d3-a456-426614174000",
  "filters": {
    "start_date": "2024-01-01T00:00:00.000Z",
    "end_date": "2024-01-31T23:59:59.999Z"
  },
  "page_size": 30,
  "sort_field": "citation_percentage",
  "sort_direction": "desc"
}

Response

Successful response with the page of sources.

Example response

{
  "sources": [
    {
      "root_domain": "wikipedia.org",
      "total_mentions": 124,
      "response_count": 86,
      "estimated_impressions": 18400,
      "domain_count": 31,
      "mention_percentage": 12.3,
      "citation_percentage": 14.1,
      "competitor_mention_percentage": 3.2,
      "brand_mention_percentage": 8.9,
      "mentions_count": 47,
      "responses_mentioned_count": 39,
      "competitor_ids": [],
      "source_type_ids": [],
      "first_seen": "2024-01-04"
    }
  ],
  "pagination": {
    "page_size": 30,
    "total": 142
  }
}