Docs
Dokumentation durchsuchen...⌘K

Zitate

API + MCP
POST/v3/brand-radar/citations-history

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

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 ist, werden andere Parameter aus dem Report übernommen (Land, Filter). Wenn Land oder Filter angegeben werden, überschreiben sie die im Report. Du findest sie in der URL deines 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
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
date_fromstring (date)Required

Das Startdatum des historischen Zeitraums im Format JJJJ-MM-TT.

date_tostring (date)

Das Enddatum des historischen Zeitraums im Format JJJJ-MM-TT.

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>
citationsinteger

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

datestring (date)