Docs
Cari dokumen...⌘K

Web Pages

API + MCPKhusus Enterprise
POST/v3/brand-radar/web-pages

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

Isi permintaan

selectarray<string>Required

A list of fields to return.

Example:["field_a","field_b"]
whereobject

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

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#/...

brandsarray<object>

A list of brand names and websites to find mentions of on web pages.

Default:[]
At least one of names or url_groups is required
namesarray<string>

The names of the brand/competitor

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

The domain of the target

Example:ahrefs.com
scopestringrequired

Scope of the target.

Nilai yang diizinkan:urlpathdomainsubdomains
competitorsarray<object>

A list of competitor names and websites to find mentions of on web pages.

Default:[]
At least one of names or url_groups is required
namesarray<string>

The names of the brand/competitor

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

The domain of the target

Example:ahrefs.com
scopestringrequired

Scope of the target.

Nilai yang diizinkan:urlpathdomainsubdomains
content_filterobject

Optional phrases used to include or exclude results based on their content.

includearray<string>

Only show results containing at least one of these exact phrases.

excludearray<string>

Hide results containing any of these exact phrases.

limitinteger

The number of web pages to return.

Default:1000
order_bystring

How to order the web pages.

Nilai yang diizinkan:relevancetraffic
Default:relevance
page_typestring

Whether to return all web pages or only news pages.

Nilai yang diizinkan:all_pagesnews
Default:all_pages
publication_typestring

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

Nilai yang diizinkan:allpublished_oncerepublished
Default:all
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.

platformstring

The platform or technology used by the page.

Nilai yang diizinkan:allblogswordpressecommercecmsmessage-boardswikis
Default:all
languagestring

The language of the page.

Nilai yang diizinkan:allenesruzh-cnjaafsqarbnbgzh-twhrcsda…
Default:all
outputstring

The output format.

Nilai yang diizinkan:jsoncsvxmlphp

Respons

pagesarray<object>
contentstring

An excerpt of the page content containing the mention.

domain_ratinginteger

The Domain Rating of the page's domain.

referring_domainsinteger or null

The number of unique domains linking to the page.

titlestring

The title of the page.

trafficnumber (float) or null

The page's estimated monthly organic search traffic.

traffic_valuenumber (float)

The estimated monthly value of the page's organic search traffic, in USD.

urlstring (url)

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