Skip to main content

List Website Search data

GET 
/ext/google/searchconsole/searches

List the Website Search performance data

Request​

Query Parameters

    website stringrequired

    The website URL

    cursor string

    The cursor

    since stringrequired

    The start date, inclusive, in yyyy-MM-dd format.

    until stringrequired

    The end date, inclusive, in yyyy-MM-dd format.

    dimensions string[]required

    The dimensions, e.g. query, page. Must repeat for each dimension.

    google_access_token stringrequired

    The Google access token, must have access to the Google Search Console scope

    limit integer

    Default value: 10

    The maximum number of results

Responses​

Found

Schema

    first stringnullablerequired

    The link to the first page.

    items

    object[]

    required

    An array of objects.

  • Array [

    • clicks int32required

    Number of clicks.

    ctr doublerequired

    CTR.

    id int64required

    The id: it's now a unique id, but a row index.

    impressions int32required

    Number of impressions.

    keys string[]required

    The keys for the current data, matching the provided dimensions in the query.

    position doublerequired

    Position.

    score doublerequired

    A score to spot traffic opportunities, from 0.0 to 1.0 (the higher the better). The score is based on the traffic data.

  • ]

    • last stringnullablerequired

    The link to the last page.

    next stringnullablerequired

    The link to the next page or null if there's no page.

    prev stringnullablerequired

    The link to the previous page or null if there's no page.

    self stringnullablerequired

    The link to the current page.