Docs
Szukaj w dokumentacji...⌘K

Przegląd – Share of Voice

API + MCP
GET/v3/brand-radar/sov-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.

Parametry zapytania

wherestring

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

countrystring

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

Dozwolone wartości: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.

Dozwolone wartości:ahrefscustom
data_sourcestringWymagane

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

Dozwolone wartości:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok
Example:chatgpt,perplexity
marketstring

Rozdzielana przecinkami lista rynków niszowych Twoich marek.

competitorsstring

Rozdzielana przecinkami lista konkurentów Twoich marek.

brandstring

Rozdzielana przecinkami lista marek do wyszukania. Co najmniej jedno z: brand, competitors, market lub where nie może być puste.

outputstring

Format wyjściowy.

Dozwolone wartości:jsoncsvxmlphp

Odpowiedzi

metricsarray<object>
brandstring

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

share_of_voicenumber

Szacowany udział głosu Twojej marki.