Docs
Cari dokumen...⌘K

Kutipan

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

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

whereobject

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

report_idstring

ID laporan yang akan digunakan. Jika diberikan, parameter lain diambil dari laporan (negara, filter). Jika negara atau filter disediakan, nilai tersebut akan menimpa yang ada di laporan. Anda bisa 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
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
date_fromstring (date)Required

Tanggal mulai periode historis dalam format YYYY-MM-DD.

date_tostring (date)

Tanggal akhir periode historis dalam format YYYY-MM-DD.

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

Perkiraan sitasi dari respons yang menyebutkan URL merek.

datestring (date)