Docs
Cari dokumen...⌘K

Kata kunci

API + MCP
GET/v3/gsc/keywords

Permintaan ke endpoint ini gratis dan tidak menghabiskan unit API.

Parameter kueri

project_idinteger

ID Proyek. Wajib diisi jika portfolio_id tidak diberikan.

portfolio_idinteger

ID Portfolio. Jika diberikan, data akan diagregasi dari semua Proyek yang terhubung ke GSC dalam Portfolio tersebut.

date_fromstring (date)Wajib

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

date_tostring (date)

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

search_typestring

Jenis hasil penelusuran yang akan dikembalikan (web, gambar, video, berita).

Nilai yang diizinkan:webimagevideonews
Default:web
countrystring

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

Nilai yang diizinkan:adaeafagaialamaoarasatauawazba
devicestring

Filter berdasarkan jenis perangkat (DESKTOP, MOBILE, TABLET). Jika tidak ditentukan, semua perangkat akan disertakan.

Nilai yang diizinkan:desktopmobiletablet
limitinteger

Jumlah hasil yang akan dikembalikan.

Default:1000
wherestring

Kolom yang didukung:

keyword_list_idinteger

ID daftar kata kunci yang sudah ada yang metriknya akan ditampilkan.

keyword_listsstring

Filter daftar kata kunci (string JSON). Mendukung include (is), exclude (is_not), empty (tidak ada dalam daftar mana pun), dan not_empty (ada dalam daftar mana pun).

outputstring

Format output.

Nilai yang diizinkan:jsonphpxml

Respons

keywordsarray<object>
clicksinteger or null
ctrnumber (float) or null
impressionsinteger or null
keywordstring
keyword_list_labelsarray<string>
positionnumber (float) or null

Posisi rata-rata (desimal, mis. 4.7)

top_urlstring (url) or null
urls_countinteger