Google Search Console

Get Search Console search queries

Changed on

Returns search queries with server-side pagination, search, tab and position-band filters, sorting and period changes. pageSize defaults to 50; use all for an explicit full export. summary describes the complete date window independently of table filters. coverage reports the window served by Google.

get/v3/integrations/gsc/website-traffic/search-queries

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/integrations/gsc/website-traffic/search-queries
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

teamIdstring required

Team ID

string
OR
integer

Number of days to look back

startDatestring

Start date (YYYY-MM-DD)

endDatestring

End date (YYYY-MM-DD)

countrystring

Country filter

devicestring

Device filter

typestring

Search appearance/type filter

limitstring

Maximum rows to return

includePagesstring

Embed each row's ranking page URLs and their metrics inside the row (multiplies the payload by the number of URLs per row). Defaults to false; the pages count is always returned.

pageinteger

1-based page. Default 1.

pageSizestring

Rows per page (max 1000), or 'all'. Every response reports total and totalPages.

searchstring
sortBy'query' | 'clicks' | 'impressions' | 'ctr' | 'position' | 'pages' | 'clicksChange' | 'impressionsChange' | 'ctrChange' | 'positionChange'
sortDir'asc' | 'desc'
tab'Top' | 'Growing' | 'Decaying' | 'Long Tail' | 'Questions'
positionBand'top3' | '4-10' | '11-20' | '21-49' | '50-100' | '100+'

Response

Default Response

totalnumber
returnednumber

Changes

  • 7ede4ba45814Revision changes
    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter pageSize

    • info

      added the new optional query request parameter positionBand

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

    • info

      added the new optional query request parameter tab

  • 3976341798f4Revision changes
    • info

      added the media type application/json for the response with the status