Docs
Cari dokumen...⌘K

Respons AI

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

Permintaan ke endpoint ini akan menghabiskan unit API berdasarkan parameter prompts: permintaan yang hanya mengembalikan data prompt kustom gratis, sedangkan permintaan yang menyertakan data prompt Ahrefs mengikuti penetapan harga unit API Standard.

Isi permintaan

brand_filterobject

Ekspresi filter untuk visibilitas merek Anda, yang mencerminkan filter “Your brand”. brand_name mencocokkan respons berdasarkan apakah respons tersebut menyebutkan merek Anda: "mentioned" atau "not_mentioned". page_status mencocokkan berdasarkan cara AI menggunakan halaman Anda: "cited" (AI mengambil halaman dari situs Anda dan merujuknya dalam jawaban), "found_but_not_cited" (AI mengambil halaman dari situs Anda sebagai sumber potensial, tetapi tidak merujuknya dalam jawaban akhir), atau "not_found" (AI tidak mengambil halaman apa pun dari situs Anda).
Menggunakan sintaks filter dengan batasan berikut: satu-satunya operator yang valid adalah "eq"; setiap field adalah satu bagian: berikan satu nilai, atau gabungkan beberapa nilai dari field yang sama dengan or; gabungkan bagian brand_name dan page_status dengan and/or tingkat teratas. Memilih semua nilai dari sebuah field akan ditolak karena cocok dengan semuanya (abaikan field tersebut).

Example:{"and":[{"field":"brand_name","is":["eq","mentioned"]},{"or":[{"field":"page_status","is":["eq","cited"]},{"field":"page_status","is":["eq","found_but_not_cited"]}]}]}
volume_rangeobject

Rentang volume yang akan difilter.

frominteger
tointeger
selectarray<string>Required

Daftar kolom untuk dikembalikan.

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

Ekspresi filter. Pengidentifikasi kolom berikut dikenali (ini berbeda dari pengidentifikasi yang dikenali oleh parameter select).

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"]}]}
limitinteger

Jumlah hasil yang akan dikembalikan.

Default:1000
datestring (date)

Tanggal yang akan dicari dalam format YYYY-MM-DD.

search_volume_typestring

Laporan visibilitas AI beralih ke volume yang disesuaikan untuk AI. Metode ini memperkirakan permintaan respons AI di berbagai chatbot dan layanan pencarian AI dengan lebih baik. Volume ini dihitung dengan menyesuaikan volume pencarian Google berdasarkan perkiraan penggunaan setiap platform AI dibandingkan dengan Google. Parameter ini akan dihentikan pada 31 Agustus 2026; semua permintaan akan menggunakan volume baru yang disesuaikan untuk AI.

Nilai yang diizinkan:ask_volumekeyword_volume
Default:ask_volume
countryarray<string>

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

Nilai yang diizinkan:adaeafagaialamaoarasatauawazba…
Default:[]
order_bystring

Kolom yang digunakan untuk mengurutkan hasil.

Nilai yang diizinkan:relevancevolume
Default:relevance
report_idstring

ID laporan yang akan digunakan. Jika diberikan, parameter lain akan diambil dari laporan (brand, pesaing, pasar, negara, filter). Jika negara atau filter diberikan, maka nilainya akan menimpa yang ada di laporan. Anda dapat menemukannya di URL laporan Brand Radar Anda di Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

promptsstring

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

Nilai yang diizinkan:ahrefscustom
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
marketarray<string>

Daftar pasar niche merek Anda. Tidak digunakan lagi sejak 2026-05-18, parameter ini tidak akan berpengaruh segera setelah tanggal tersebut.

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/kompetitor

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

Domain target

Example:ahrefs.com
scopestringrequired

Cakupan target.

Nilai yang diizinkan:urlpathdomainsubdomains
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/kompetitor

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

Domain target

Example:ahrefs.com
scopestringrequired

Cakupan target.

Nilai yang diizinkan:urlpathdomainsubdomains
outputstring

Format output.

Nilai yang diizinkan:jsonphp

Respons

ai_responsesarray<object>
countrystring

Negara dari pertanyaan tersebut.

data_sourcestring

Model chatbot yang menghasilkan respons.

last_updatedstring (date)

Tanggal saat data terakhir kali diperbarui.

linksarray<object>

(10 unit) Tautan yang digunakan untuk respons.

urlstring
titlestring or null
questionstring

Pertanyaan yang diajukan oleh pengguna.

responsestring

(10 unit) Respons dari model.

search_queriesarray<string>

Kueri pencarian yang digunakan chatbot untuk menemukan informasi untuk respons. Catatan: jika data_source tidak mencakup chatgpt atau perplexity, kolom ini akan selalu kosong.

tagsarray<string>

Tag yang ditetapkan pada kueri.

volumeinteger

(10 unit) Perkiraan volume pencarian bulanan. Ini didasarkan pada perkiraan kami untuk Google, dengan menggabungkan volume pencarian kata kunci terkait di mana pertanyaan ini muncul di bagian People Also Ask.