Rank Tracking

Top keywords from GSC

Changed on

Returns the top performing keywords from Google Search Console for a team.

get/v3/rank-tracking/top-keywords

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/rank-tracking/top-keywords
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

pageinteger
searchstring
sortBy'kw' | 'pos' | 'imp' | 'clicks' | 'pages' | 'posDelta'
sortDir'asc' | 'desc'
category'rising' | 'falling' | 'new' | 'lost'
teamIdstring

Team ID

startDatestring

Start date (YYYY-MM-DD, UTC). Preferred over days; ranges over 365 days are clamped. Omit with endDate set for All Time: tracked data starts at the first stored reading, Search Console at its oldest kept day (about 16 months), and no period comparison or change values are returned.

endDatestring

End date (YYYY-MM-DD, UTC). Preferred over days.

daysinteger

Number of days to look back (legacy fallback)

devicestring

Device filter

typestring

Search type filter

countrystring

Country filter

scope'all' | 'ranked' | 'tracked'

Keyword universe: all (GSC + tracked merged), ranked (GSC only), tracked (tracked only). Defaults to all.

limitinteger

Max results

pageSizestring

Rows to return, or all.

includeComparisonstring

Include period-over-period comparison

includePagesstring

Embed each keyword's ranking page URLs (two extra Search Console queries plus every stored SERP page). Defaults to true; pass false when only the keyword rows are rendered.

currentPeriodDaysinteger

Days in current period (legacy fallback)

previousPeriodDaysinteger

Days in previous period (legacy fallback)

Response

Default Response

pageinteger
pageSizeinteger
totalinteger
totalPagesinteger

Changes

  • 7ede4ba45814Revision changes
    • info

      added the new optional query request parameter category

    • 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 search

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 623d4784f6e6Revision changes
    • info

      added the new optional query request parameter includePages