Kutipan

API + MCP

POST/v3/brand-radar/citations-overview

Permintaan ke endpoint ini menggunakan unit API berdasarkan parameter prompts: permintaan yang hanya mengembalikan data prompt kustom tidak dikenai biaya, sedangkan permintaan yang menyertakan data prompt Ahrefs mengikuti tarif unit API standar.

Setiap entitas yang diberikan dalam brands (dan competitors, jika berlaku) harus menyertakan setidaknya satu nilai dalam url_groups. Entitas yang hanya terdiri dari names tidak didukung di sini karena sitasi dicocokkan dengan grup URL.

Isi permintaan

selectarray<string>Required

Daftar kolom untuk dikembalikan.

Example:["field_a","field_b"]

whereobject

Ekspresi filter. Pengenal kolom berikut dikenali (ini berbeda dari pengenal yang dikenali oleh parameter select).

report_idstring

ID laporan yang akan digunakan. Jika ID diberikan, parameter lainnya diambil dari laporan (brand, competitors, market, country, filters). Jika country atau filters disediakan, parameter tersebut akan menggantikan yang ada di laporan. Anda dapat menemukannya di URL laporan Brand Radar Anda di Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

Daftar nama merek dan situs web yang akan dicari.

Default:[]

At least one of names or url_groups is required

namesarray<string>

Nama merek/pesaing

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

url_groupsarray<object>

targetstring (domain)required

Domain target

Example:ahrefs.com

scopestringrequired

Cakupan target.

Nilai yang diizinkan:urlpathdomainsubdomains

competitorsarray<object>

Daftar nama kompetitor dan situs web yang akan dicari.

Default:[]

At least one of names or url_groups is required

namesarray<string>

Nama merek/pesaing

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

url_groupsarray<object>

targetstring (domain)required

Domain target

Example:ahrefs.com

scopestringrequired

Cakupan target.

Nilai yang diizinkan:urlpathdomainsubdomains

content_filterobject

Frasa opsional yang digunakan untuk menyertakan atau mengecualikan hasil berdasarkan kontennya.

includearray<string>

Hanya tampilkan hasil yang berisi setidaknya salah satu dari frasa yang sama persis berikut.

excludearray<string>

Sembunyikan hasil yang berisi salah satu dari frasa yang sama persis berikut.

data_sourcearray<string>Required

Daftar model chatbot. Semua model dapat dikombinasikan satu sama lain. Modul claude hanya mendukung prompt kustom.
Model google_ai_overviews_keywords dan google_ai_mode_keywords melaporkan visibilitas AI Overviews / AI Mode yang diperoleh dari kueri pencarian Google (kata kunci), bukan dari prompt.

Nilai yang diizinkan:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords

countryarray<string>

Daftar kode negara dua huruf (ISO 3166-1 alpha-2).

Nilai yang diizinkan:adaeafagaialamaoarasatauawazba…

Default:[]

promptsstring

Jenis prompt yang akan digunakan. Jika tidak ditentukan, keduanya akan digunakan. Prompt kustom mengharuskan report_id disertakan.

Nilai yang diizinkan:ahrefscustom

tags_filterobject

Ekspresi filter untuk tag prompt. Memerlukan report_id. Menggunakan sintaks filter dengan batasan berikut: satu-satunya nama field yang valid adalah "tag"; operator yang valid hanyalah: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; kedalaman nesting maksimum untuk and dan or adalah 2.

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

outputstring

Format output.

Nilai yang diizinkan:jsoncsvxmlphp

Respons

metricsarray<object>

brandstring

Nama merek (baik merek Anda maupun pesaing yang disertakan dalam permintaan).

entity_typestring

Apakah baris tersebut merepresentasikan agregat, merek target Anda, atau kompetitor.

Nilai yang diizinkan:aggregatetargetcompetitor

no_tracked_brandsinteger

Perkiraan sitasi dari respons terkait pasar yang ditentukan yang tidak menyebutkan URL merek yang disediakan (nilainya nol jika market tidak ditentukan).

only_competitors_brandsinteger

Perkiraan sitasi dari respons yang hanya menyebutkan URL merek pesaing.

only_target_brandinteger

Perkiraan sitasi dari respons yang hanya menyebutkan URL merek Anda.

target_and_competitors_brandsinteger

Perkiraan sitasi dari respons yang menyebutkan URL merek Anda dan URL merek pesaing.

totalinteger

Total sitasi yang diperkirakan untuk URL merek Anda (mencakup only_target_brand dan 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 } ] }