Docs
Dokumentation durchsuchen...⌘K

KI-Antworten

API + MCP
POST/v3/brand-radar/ai-responses

Anfragen an diesen Endpoint verbrauchen API-Einheiten basierend auf dem Parameter prompts: Anfragen, die ausschließlich Daten zu einem eigenen Prompt zurückgeben, sind kostenlos, während Anfragen mit Ahrefs-Prompt-Daten der Standard-Preisgestaltung für API-Einheiten folgen.

Anfrage-Body

selectarray<string>Required

Eine Liste der zurückzugebenden Spalten. Siehe Antwortschema für gültige Spaltenkennungen.

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

Der Filterausdruck. Folgende Spaltenkennungen werden erkannt (dies unterscheidet sich von den Kennungen, die vom Parameter select erkannt werden).

cited_domain: Die Domain einer Seite, die zur Erstellung der Antwort verwendet wurde.
typ: domain

cited_domain_subdomains: Die Domain einer Seite, die zur Erstellung der Antwort verwendet wurde. Jede Subdomain der angegebenen Domain wird ebenfalls berücksichtigt.
typ: string

cited_url_exact: Die URL einer Seite, die zur Erstellung der Antwort verwendet wurde.
typ: string

cited_url_prefix: Die URL einer Seite, die zur Erstellung der Antwort verwendet wurde. Jede URL, die mit diesem Präfix beginnt, wird berücksichtigt.
typ: string

question: Die vom Benutzer gestellte Frage.
typ: string

response (10 Einheiten): Die Antwort des Modells.
typ: string

search_queries: Die Suchanfrage, die der Chatbot verwendet hat, um Informationen für die Antwort zu finden. Hinweis: Wenn data_source weder chatgpt noch perplexity enthält, ist dieses Feld immer leer.
typ: string

topic: Das Thema der Anfrage.
typ: string

tags_filterobject

Ein Filterausdruck für Prompt-Tags. Erfordert report_id. Verwendet die Filtersyntax mit folgenden Einschränkungen: Der einzige gültige Feldname ist "tag"; die einzigen gültigen Operatoren sind: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; die maximale Verschachtelungstiefe von and und or beträgt 2. Beispiel: {"or": [{"field": "tag", "is": ["eq", "branded"]}, {"field": "tag", "is": ["eq", "competitor"]}]}.

limitinteger

Die Anzahl der zurückzugebenden Ergebnisse.

Default:1000
datestring

Das zu durchsuchende Datum im Format YYYY-MM-DD.

countryarray<string>

Eine Liste zweistelliger Ländercodes (ISO 3166-1 alpha-2).

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
order_bystring

Eine Spalte, nach der die Ergebnisse sortiert werden sollen.

Allowed values:relevancevolume
Default:relevance
report_idstring

Die ID des zu verwendenden Reports. Wenn eine angegeben ist, werden andere Parameter aus dem Report übernommen (Marke, Wettbewerber, Markt, Land, Filter). Wenn Land oder Filter angegeben werden, haben sie Vorrang vor den Angaben im Report. Du findest sie in der URL deines Brand-Radar-Reports in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

promptsstring

Der Typ der zu verwendenden Prompts. Wenn nicht angegeben, werden beide verwendet. Eigene Prompts erfordern, dass eine report_id angegeben wird.

Allowed values:ahrefscustom
data_sourcearray<string>Required

Eine Liste von Chatbot-Modellen. Google-Modelle (google_ai_overviews, google_ai_mode) können weder miteinander noch mit Nicht-Google-Modellen kombiniert werden.

Allowed values:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok
marketarray<string>

Eine Liste der Nischenmärkte deiner Marken.

competitorsarray<object>

Eine Liste von Wettbewerbernamen und Websites, nach denen gesucht werden soll.

At least one of names or url_groups is required
namesarray<string>

Die Namen der Marke/des Wettbewerbers

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstringrequired

Die Domain des Ziels

Example:ahrefs.com
scopestringrequired

Geltungsbereich des Ziels.

Allowed values:urlpathdomainsubdomains
brandsarray<object>

Eine Liste von Markennamen und Websites, nach denen gesucht werden soll.

At least one of names or url_groups is required
namesarray<string>

Die Namen der Marke/des Wettbewerbers

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstringrequired

Die Domain des Ziels

Example:ahrefs.com
scopestringrequired

Geltungsbereich des Ziels.

Allowed values:urlpathdomainsubdomains
outputstring

Das Ausgabeformat.

Allowed values:jsonphp

Antworten

ai_responsesarray<object>
countrystring

Das Land der Frage.

data_sourcestring

Das Chatbot-Modell, das die Antwort generiert hat.

linksarray<object>

(10 Einheiten) Die für die Antwort verwendeten Links.

questionstring

Die vom Nutzer gestellte Frage.

responsestring

(10 Einheiten) Die Antwort des Modells.

search_queriesarray<string>

Die vom Chatbot verwendete Suchanfrage, um Informationen für die Antwort zu finden. Hinweis: Wenn data_source weder chatgpt noch perplexity enthält, ist dieses Feld immer leer.

tagsarray<string>

Der Anfrage zugewiesene Tags.

volumeinteger

(10 Einheiten) Geschätzte monatliche Suchanfragen. Dies basiert auf unseren Schätzungen für Google und kombiniert die Suchvolumina verwandter Keywords, in deren „Weitere Fragen"-Bereich diese Frage erscheint.