AHahrefs
Brand Radar

Web Pages

Changed on

Returns web pages that mention the requested brands or competitors. Brand mentions are matched against page titles and content from Ahrefs' web index.

post/brand-radar/web-pages

Request

  • Base URL
    https://api.ahrefs.com/v3
  • URL
    https://api.ahrefs.com/v3/brand-radar/web-pages
  • Auth
    HTTP bearer

Request body

selectstring[] required

A list of fields to return.

  • content
  • domain_rating
  • referring_domains
  • title
  • traffic
  • traffic_value
  • url
whereobject

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the select parameter).

content: An excerpt of the page content containing the mention.
type: string

title: The title of the page.
type: string

url: The URL of the page mentioning a requested brand or competitor.
type: url

report_idstring

The ID of the report to use. If one is given, other parameters are taken from the report (brand, competitors, market, country, filters). If country or filters are provided, they override the ones in the report. You can find it in the URL of your Brand Radar report in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

limitinteger

The number of web pages to return.

order_by'relevance' | 'traffic'

How to order the web pages.

page_type'all_pages' | 'news'

Whether to return all web pages or only news pages.

publication_type'all' | 'published_once' | 'republished'

Whether to return all pages, pages published once, or republished pages.

date_fromstring date

The start of the publication-date range, in YYYY-MM-DD format. Requires date_to.

date_tostring date

The inclusive end of the publication-date range, in YYYY-MM-DD format. Requires date_from.

platform'all' | 'blogs' | 'wordpress' | 'ecommerce' | 'cms' | 'message-boards' | 'wikis'

The platform or technology used by the page.

language'all' | 'en' | 'es' | 'ru' | 'zh-cn' | 'ja' | 'af' | 'sq' | 'ar' | 'bn' | 'bg' | 'zh-tw' | 'hr' | 'cs' | 'da' | 'nl' | 'et' | 'fa' | 'fi' | 'fr' | 'de' | 'el' | 'gu' | 'he' | 'hi' | 'hu' | 'id' | 'it' | 'kn' | 'ko' | 'lv' | 'lt' | 'mk' | 'ml' | 'mr' | 'ne' | 'no' | 'pa' | 'pl' | 'pt' | 'ro' | 'sk' | 'sl' | 'so' | 'sw' | 'sv' | 'tl' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'ur' | 'vi'

The language of the page.

output'json' | 'csv' | 'xml' | 'php'

The output format.

Example request

{
  "select": [
    "field_a",
    "field_b"
  ],
  "brands": [
    {
      "names": [
        "ahrefs",
        "ahrefs seo"
      ],
      "url_groups": [
        {
          "target": "ahrefs.com"
        }
      ]
    }
  ],
  "competitors": [
    {
      "names": [
        "ahrefs",
        "ahrefs seo"
      ],
      "url_groups": [
        {
          "target": "ahrefs.com"
        }
      ]
    }
  ]
}

Response

OK

Changes