Zitate

API + MCP

POST/v3/brand-radar/citations-overview

Anfragen an diesen Endpunkt verbrauchen API-Einheiten basierend auf dem Parameter prompts: Anfragen, die nur Daten zu eigenen Prompts zurückgeben, sind kostenlos, während Anfragen mit Ahrefs-Prompt-Daten nach der Standardpreisgestaltung für API-Einheiten berechnet werden.

Jede in brands (und gegebenenfalls competitors) angegebene Entität muss mindestens einen Wert in url_groups enthalten. Entitäten, die nur aus names bestehen, werden hier nicht unterstützt, da Zitationen anhand von URL-Gruppen abgeglichen werden.

Anfrage-Body

selectarray<string>Required

Eine Liste der zurückzugebenden Felder.

Example:["field_a","field_b"]

whereobject

Der Filterausdruck. Die folgenden Spaltenbezeichner werden erkannt (dies unterscheidet sich von den Bezeichnern, die vom Parameter select erkannt werden).

report_idstring

Die ID des zu verwendenden Reports. Wenn eine angegeben wird, werden andere Parameter aus dem Report übernommen (brand, competitors, market, country, filters). Wenn country oder filters angegeben werden, überschreiben sie die Werte im Report. Sie finden sie in der URL Ihres Brand-Radar-Reports in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

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

Default:[]

At least one of names or url_groups is required

namesarray<string>

Die Namen der Marke/des Mitbewerbers

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

url_groupsarray<object>

targetstring (domain)required

Die Domain des Ziels

Example:ahrefs.com

scopestringrequired

Geltungsbereich des Ziels.

Zulässige Werte:urlpathdomainsubdomains

competitorsarray<object>

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

Default:[]

At least one of names or url_groups is required

namesarray<string>

Die Namen der Marke/des Mitbewerbers

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

url_groupsarray<object>

targetstring (domain)required

Die Domain des Ziels

Example:ahrefs.com

scopestringrequired

Geltungsbereich des Ziels.

Zulässige Werte:urlpathdomainsubdomains

content_filterobject

Optionale Phrasen, mit denen Ergebnisse anhand ihres Inhalts ein- oder ausgeschlossen werden können.

includearray<string>

Zeigt nur Ergebnisse an, die mindestens eine dieser exakten Phrasen enthalten.

excludearray<string>

Blendet Ergebnisse aus, die eine dieser exakten Phrasen enthalten.

data_sourcearray<string>Required

Eine Liste von Chatbot-Modellen. Alle Modelle können miteinander kombiniert werden. Das claude-Modul unterstützt nur eigene Prompts.
Die Modelle google_ai_overviews_keywords und google_ai_mode_keywords geben die Sichtbarkeit in AI Overviews / im AI Mode an, die aus Google-Suchanfragen (Keywords) statt aus Prompts abgeleitet wird.

Zulässige Werte:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords

countryarray<string>

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

Zulässige Werte:adaeafagaialamaoarasatauawazba…

Default:[]

promptsstring

Der Typ der zu verwendenden Prompts. Wenn nicht angegeben, werden beide verwendet. Eigene Prompts erfordern die Angabe einer report_id.

Zulässige Werte:ahrefscustom

tags_filterobject

Ein Filterausdruck für Prompt-Tags. Erfordert report_id. Verwendet die Filter-Syntax 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 für and und or beträgt 2.

Example:{"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}

outputstring

Das Ausgabeformat.

Zulässige Werte:jsoncsvxmlphp

Antworten

metricsarray<object>

brandstring

Markenname (entweder Ihre Marke oder ein in der Anfrage angegebener Wettbewerber).

entity_typestring

Gibt an, ob die Zeile ein Aggregat, Ihre Zielmarke oder einen Mitbewerber darstellt.

Zulässige Werte:aggregatetargetcompetitor

no_tracked_brandsinteger

Geschätzte Anzahl von Zitationen in Antworten, die sich auf den angegebenen Markt beziehen und keine der bereitgestellten Marken-URLs erwähnen (der Wert ist 0, wenn market nicht angegeben ist).

only_competitors_brandsinteger

Geschätzte Anzahl von Zitationen in Antworten, die ausschließlich Marken-URLs von Mitbewerbern erwähnen.

only_target_brandinteger

Geschätzte Anzahl von Zitationen in Antworten, die ausschließlich Ihre Marken-URLs erwähnen.

target_and_competitors_brandsinteger

Geschätzte Anzahl von Zitationen in Antworten, die sowohl Ihre Marken-URLs als auch die Marken-URLs von Mitbewerbern erwähnen.

totalinteger

Geschätzte Gesamtzahl der Zitationen für Ihre Marken-URLs (umfasst sowohl only_target_brand als auch target_and_competitors_brands).

curl "https://api.ahrefs.com/v3/brand-radar/citations-overview" \ -X POST \ -H "Authorization: Bearer $AHREFS_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data-raw '{ "select": ["field_a","field_b"], "where": {}, "report_id": "string", "brands": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "competitors": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "content_filter": { "include": ["string"], "exclude": ["string"] }, "data_source": ["chatgpt"], "country": ["ad"], "prompts": "ahrefs", "tags_filter": {"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}, "output": "json" }'

{ "metrics": [ { "brand": "string", "entity_type": "aggregate", "no_tracked_brands": 0, "only_competitors_brands": 0, "only_target_brand": 0, "target_and_competitors_brands": 0, "total": 0 } ] }