Docs
Cari dokumen...⌘K

Ringkasan - Tayangan

API + MCP
POST/v3/brand-radar/impressions-overview

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

whereobject

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

selectarray<string>Required

Daftar kolom untuk dikembalikan.

Example:["field_a","field_b"]
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"]}]}.

countryarray<string>

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

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

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.

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

Allowed values:urlpathdomainsubdomains
outputstring

Format output.

Allowed values:jsoncsvxmlphp

Respons

metricsarray<object>
brandstring

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

no_tracked_brandsinteger

Perkiraan impresi dari respons yang terkait dengan pasar yang ditentukan dan tidak menyebutkan merek apa pun yang diberikan (nilainya nol ketika market tidak ditentukan).

only_competitors_brandsinteger

Perkiraan impresi dari respons yang hanya menyebutkan merek pesaing.

only_target_brandinteger

Perkiraan impresi dari respons yang hanya menyebutkan merek Anda.

target_and_competitors_brandsinteger

Perkiraan impresi dari respons yang menyebutkan merek Anda dan merek pesaing.

totalinteger

Total perkiraan impresi untuk merek Anda (mencakup only_target_brand dan target_and_competitors_brands).