Skip to main content
POST
Query Search Console clicks, impressions, CTR and position

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Project id (proj_…) or slug (the domain with dots as dashes).

Body

application/json
dimensions
enum<string>[]

Group rows by these; an empty list gives the totals only.

Maximum array length: 4
Available options:
query,
page,
country,
device,
searchAppearance,
date
startDate
string<date>

First day (YYYY-MM-DD, Pacific time). Defaults to 28 days before endDate.

endDate
string<date>

Last day (YYYY-MM-DD). Defaults to 3 days ago, the last final day.

country
string

ISO 3166-1 alpha-2 country, e.g. tr. Defaults to the project country; all reads every country.

filters
object[]
Maximum array length: 10
type
enum<string>
default:web
Available options:
web,
image,
video,
news,
discover,
googleNews
fresh
boolean
default:false

Include the last 2–3 days, which Google is still counting.

limit
integer
default:100

Rows per page, most clicks first, as Google orders them.

Required range: 1 <= x <= 1000
cursor
string

Response

Rows

property
string
required
country
string | null
required
type
enum<string>
required
Available options:
web,
image,
video,
news,
discover,
googleNews
period
object
required
totals
object
required
rows
object[]
required
nextCursor
string | null
required
{key}
any