Przegląd – Wzmianki

API + MCP

POST/v3/brand-radar/mentions-overview

Żądania do tego punktu końcowego zużywają jednostki API w zależności od parametru prompts: żądania zwracające wyłącznie dane niestandardowego promptu są bezpłatne, natomiast żądania uwzględniające dane promptów Ahrefs są rozliczane zgodnie ze standardowym cennikiem jednostek API.

Treść żądania

selectarray<string>Required

Lista kolumn do zwrócenia. Zobacz schemat odpowiedzi, aby poznać prawidłowe identyfikatory kolumn.

Example:["field_a","field_b"]

whereobject

Wyrażenie filtra. Rozpoznawane są następujące identyfikatory kolumn (różnią się one od identyfikatorów rozpoznawanych przez parametr select).

cited_domain: Domena strony, która została użyta do wygenerowania odpowiedzi.
type: domain

cited_domain_subdomains: Domena strony, która została użyta do wygenerowania odpowiedzi. Dopasowane zostaną również wszystkie subdomeny podanej domeny.
type: string

cited_url_exact: Adres URL strony, która została użyta do wygenerowania odpowiedzi.
type: string

cited_url_prefix: Adres URL strony, która została użyta do wygenerowania odpowiedzi. Dopasowany zostanie każdy adres URL zaczynający się od tego prefiksu.
type: string

question: Pytanie zadane przez użytkownika.
type: string

response (10 units): Odpowiedź modelu.
type: string

search_queries: Zapytanie wyszukiwania użyte przez chatbota do znalezienia informacji do odpowiedzi. Uwaga: jeśli data_source nie zawiera chatgpt ani perplexity, to pole będzie zawsze puste.
type: string

topic: Temat zapytania.
type: string

tags_filterobject

Wyrażenie filtra dla tagów promptu. Wymaga report_id. Używa składni filtrów z następującymi ograniczeniami: jedyną prawidłową nazwą pola jest "tag"; jedynymi prawidłowymi operatorami są: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; maksymalna głębokość zagnieżdżenia and oraz or wynosi 2. Przykład: {"or": [{"field": "tag", "is": ["eq", "branded"]}, {"field": "tag", "is": ["eq", "competitor"]}]}.

countryarray<string>

Lista dwuliterowych kodów krajów (ISO 3166-1 alpha-2).

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

report_idstring

Identyfikator raportu, którego należy użyć. Jeśli zostanie podany, pozostałe parametry są pobierane z raportu (marka, konkurenci, rynek, kraj, filtry). Jeśli podasz kraj lub filtry, zastąpią one wartości z raportu. Znajdziesz go w adresie URL raportu Brand Radar w Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

promptsstring

Typ promptów, których należy użyć. Jeśli nie zostanie określony, użyte zostaną oba. Niestandardowe prompty wymagają podania report_id.

Allowed values:ahrefscustom

data_sourcearray<string>Required

Lista modeli chatbota. Modeli Google (google_ai_overviews, google_ai_mode) nie można łączyć ze sobą ani z modelami spoza Google.

Allowed values:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok

marketarray<string>

Lista rynków niszowych Twoich marek.

competitorsarray<object>

Lista nazw konkurentów i stron internetowych do wyszukania.

At least one of names or url_groups is required

namesarray<string>

Nazwy marki/konkurenta

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstringrequired

Domena celu

Example:ahrefs.com

scopestringrequired

Zakres celu.

Allowed values:urlpathdomainsubdomains

brandsarray<object>

Lista nazw marek i stron internetowych do wyszukania.

At least one of names or url_groups is required

namesarray<string>

Nazwy marki/konkurenta

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstringrequired

Domena celu

Example:ahrefs.com

scopestringrequired

Zakres celu.

Allowed values:urlpathdomainsubdomains

outputstring

Format wyjściowy.

Allowed values:jsoncsvxmlphp

Odpowiedzi

metricsarray<object>

brandstring

Nazwa marki (Twojej lub konkurenta podanego w żądaniu).

no_tracked_brandsinteger

Szacowana liczba wzmianek na podstawie odpowiedzi związanych z określonym rynkiem, w których nie wspomniano żadnej z podanych marek (wartość wynosi zero, gdy market nie jest określony).

only_competitors_brandsinteger

Szacowana liczba wzmianek na podstawie odpowiedzi, w których wspomniano wyłącznie marki konkurencji.

only_target_brandinteger

Szacowana liczba wzmianek na podstawie odpowiedzi, w których wspomniano wyłącznie Twoją markę.

target_and_competitors_brandsinteger

Szacowana liczba wzmianek na podstawie odpowiedzi, w których wspomniano zarówno Twoją markę, jak i marki konkurencji.

totalinteger

Łączna szacowana liczba wzmianek dla Twojej marki (obejmuje zarówno only_target_brand, jak i target_and_competitors_brands).