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

volume_rangeobject

Rentang volume yang akan difilter.

frominteger

tointeger

selectarray<string>Required

Daftar kolom untuk dikembalikan. Kolom yang tersedia: question, response, volume, country, links, search_queries, tags, data_source, last_updated.

Example:["field_a","field_b"]

whereobject

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

cited_domain: Domain dari halaman yang digunakan untuk menghasilkan respons.
tipe: domain

cited_domain_subdomains: Domain dari halaman yang digunakan untuk menghasilkan respons. Subdomain apa pun dari domain yang diberikan juga akan cocok.
tipe: string

cited_url_exact: URL dari halaman yang digunakan untuk menghasilkan respons.
tipe: string

cited_url_prefix: URL dari halaman yang digunakan untuk menghasilkan respons. URL apa pun yang diawali dengan prefiks ini akan cocok.
tipe: string

question: Pertanyaan yang diajukan oleh pengguna.
tipe: string

response (10 unit): Respons dari model.
tipe: string

search_queries: Kueri penelusuran yang digunakan chatbot untuk menemukan informasi untuk respons. Catatan: jika data_source tidak menyertakan chatgpt atau perplexity, kolom ini akan selalu kosong.
tipe: string

topic: Topik kueri.
tipe: string

tags_filterobject

Ekspresi filter untuk tag prompt. Memerlukan report_id. Menggunakan sintaks filter dengan batasan berikut: satu-satunya nama kolom yang valid adalah "tag"; operator yang valid hanya: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; kedalaman nesting maksimum untuk and, or adalah 2. Contoh: {"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.

countryarray<string>

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

Default:

order_bystring

Kolom untuk mengurutkan hasil.

Allowed values:relevancevolume

Default:relevance

report_idstring

ID laporan yang akan digunakan. Jika diberikan, parameter lainnya diambil dari laporan (merek, kompetitor, pasar, negara, filter). Jika negara atau filter diberikan, keduanya 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 disediakan.

Allowed values:ahrefscustom

data_sourcearray<string>Required

Daftar model chatbot. Model kata kunci Google (google_ai_overviews_keywords, google_ai_mode_keywords) tidak dapat digabungkan satu sama lain maupun dengan model lain.

Allowed values:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotgrokgoogle_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.

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.

Allowed values:urlpathdomainsubdomains

brandsarray<object>

Daftar nama merek dan situs web yang akan dicari.

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.

Allowed values:urlpathdomainsubdomains

outputstring

Format output.

Allowed values: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.