get_rankings
A client's keyword rankings in Google and Bing: per keyword the position among organic results and among everything on the page, the change since the last comparable check, the ranking page and whether it is the page the client wants to rank, the local pack position, whether an AI Overview was shown and cited the site, and when it was checked. Also a summary over the keywords of the chosen engine and device (top 3, 10 and 20 with sample size, average position, distribution, movement), the same per tag and for branded and non-branded keywords, monthly search ranges per keyword, and competitors' positions. Rows are paged and filterable (column, tag, search, branded, within, movement, aiOverview, needsAttention, compareDays). Definitions arrive in howToRead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Only keywords with this tag. | |
| page | No | Default 1. | |
| sort | No | Default keyword. volume = monthly searches. | |
| column | No | Engine, device and list the summary, filters and sorting refer to, e.g. "google.desktop.organic", "google.mobile.organic", "bing.desktop.organic", "google.desktop.local_finder". Default: the first one switched on (see get_rank_tracking_setup). | |
| search | No | Only keywords containing this text. | |
| within | No | Only keywords ranking in the top 3 or the top 10. | |
| branded | No | Only keywords that name the client's brand terms (branded) or none of them (nonbranded): the client's name, website name and AI Visibility brand names plus the terms added in its brand terms, matched as whole words, any case, accents ignored. Narrows the summary too. Omit for every keyword. | |
| crossed | No | Only keywords that entered or left the top 3 / top 10 between the two checks compared. Outside includes not found. | |
| clientId | Yes | Client id (from list_clients). | |
| movement | No | Only keywords with this kind of change against the check they are compared with. | |
| pageSize | No | Default 50, maximum 200. | |
| targetId | No | Whose positions to read (from get_rank_tracking_setup targets). Default: the client's own site. | |
| direction | No | Default asc. Keywords without a number always come last. | |
| aiOverview | No | Only keywords by AI Overview state: cited = shown and the site is a source; present = shown, site not cited; unknown = shown but its sources were not delivered. | |
| compareDays | No | Measure every change against the newest check of the same kind of results page that is at least this many whole UTC days older, instead of the last comparable check. A keyword with no check that old is not compared. | |
| rankingPage | No | Only keywords whose ranking page differs from / matches the page the client wants to rank. | |
| needsAttention | No | Only keywords whose last search failed, is unconfirmed, was partial, came back as a different kind of results page, or has an AI Overview with unknown sources. |