v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Sources

List Source Pages (per URL)

Returns individual cited URLs for a website with citation, mention, and impression metrics — one row per normalized_url. Each row also includes a daily_mentions sparkline (citation percentage per day across the date range) and the same source-type classification as POST /api/v1/sources.

Use this when you need URL-level resolution (e.g. drill into which specific articles on a partner domain drove citations). For the root-domain rollup, use POST /api/v1/sources.

post/api/v1/source-pages

Request body

website_idstring uuid required

The website to list cited URLs for.

page_numinteger
page_sizeinteger
sort_field'citation_percentage' | 'estimated_impressions' | 'total_mentions' | 'mentions_count' | 'normalized_url' | 'competitor_ids' | 'first_seen'
sort_direction'asc' | 'desc'
searchstring nullable

Substring filter on normalized_url AND normalized_root_domain. Protocol (https://), www., query, and fragment are stripped before matching; path is preserved so URL-specific searches still work.

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
}

Response

Successful response with the page of cited URLs.

Example response

{
  "pages": [
    {
      "normalized_url": "wikipedia.org/wiki/Customer_Relationship_Management",
      "domain": "en.wikipedia.org",
      "root_domain": "wikipedia.org",
      "normalized_root_domain": "wikipedia.org",
      "total_mentions": 24,
      "estimated_impressions": 3400,
      "citation_percentage": 2.7,
      "mentions_count": 9,
      "competitor_ids": [],
      "first_seen": "2024-01-07",
      "daily_mentions": [
        {
          "date": "2024-01-07",
          "citation_percentage": 0.4
        }
      ]
    }
  ],
  "pagination": {
    "page_size": 30,
    "total": 142
  }
}