Docs
Search docs...⌘K

Overview

API + MCP
GET/v3/rank-tracker/overview

Requests to this endpoint are free and do not consume any API units.

Query parameters

timeoutinteger

A manual timeout duration in seconds.

limitinteger

The number of results to return.

Default:1000
order_bystring

A comma-separated list of columns to order results by, with optional direction. See response schema for valid column identifiers.

Example:field_a,field_b:asc,field_c:desc
wherestring

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the select parameter).

selectstringRequired

A comma-separated list of columns to return. See response schema for valid column identifiers.

date_comparedstring (date)

A date to compare metrics with in YYYY-MM-DD format.

datestring (date)Required

A date to report metrics on in YYYY-MM-DD format.

devicestringRequired

Choose between mobile and desktop rankings.

Allowed values:desktopmobile
project_idintegerRequired

The unique identifier of the project. You can find it in the URL of your Rank Tracker project in Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#

volume_modestring

The search volume calculation mode: monthly or average. It affects volume, traffic, and traffic value.

Allowed values:monthlyaverage
Default:monthly
outputstring

The output format.

Allowed values:jsoncsvxmlphp

Responses

overviewsarray<object>
best_position_has_thumbnailboolean or null

The top position (or target URL’s, if set) has a thumbnail.

best_position_has_thumbnail_previousboolean or null

The top position (or target URL’s, if set) has a thumbnail on the comparison date.

best_position_has_video_previewboolean or null

The top position (or target URL’s, if set) has a video preview.

best_position_has_video_preview_previousboolean or null

The top position (or target URL’s, if set) has a video preview on the comparison date.

best_position_kindstring or null

The kind of top position (or target URL’s, if set): organic, paid, or a SERP feature.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shopping
best_position_kind_previousstring or null

The kind of top position (or target URL’s, if set) on the comparison date.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shopping
clicksinteger or null

Clicks metric refers to the average monthly number of clicks on the search results that people make while searching for the target keyword. Some searches generate clicks on multiple results, while others might not end in any clicks at all.

clicks_per_searchnumber (float) or null

Clicks Per Search is the ratio of Clicks to Keyword Search volume. It shows how many different search results get clicked, on average, when people search for the target keyword in a given country.

cost_per_clickinteger or null

Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword.

countrystring

The country that a given keyword is being tracked in. A two-letter country code (ISO 3166-1 alpha-2).

Allowed values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMOTHERPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
country_prevstring

The country that a given keyword is being tracked in on the comparison date. A two-letter country code (ISO 3166-1 alpha-2).

Allowed values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMOTHERPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
created_atstring (date-time)

The date when a keyword was added to the project.

is_brandedboolean

User intent: branded. The user is searching for a specific brand or company name.

is_commercialboolean

User intent: commercial. The user is comparing products or services before making a purchase decision.

is_informationalboolean

User intent: informational. The user is looking for information or an answer to a specific question.

is_localboolean

User intent: local. The user is looking for information relevant to a specific location or nearby services.

is_navigationalboolean

User intent: navigational. The user is searching for a specific website or web page.

is_transactionalboolean

User intent: transactional. The user is ready to complete an action, often a purchase.

keywordstring

The keyword your target ranks for.

keyword_difficultyinteger or null

An estimation of how hard it is to rank in the top 10 organic search results for a keyword on a 100-point scale.

keyword_has_databoolean

Will return false if the keyword is still processing and no SERP has been fetched yet.

keyword_is_frozenboolean

Indicates whether a keyword has exceeded the tracked keywords limit on your plan. Such keywords are "frozen", meaning they do not have their rankings updated.

keyword_prevstring

The keyword your target ranks for on the comparison date.

languagestring

The SERP language that a given keyword is being tracked for.

language_prevstring

The SERP language on the comparison date.

locationstring

The location (country, state/province, or city) that a given keyword is being tracked in.

location_prevstring

The location (country, state/province, or city) that a given keyword is being tracked in on the comparison date.

parent_topicstring or null

Parent Topic determines if you can rank for your target keyword while targeting a more general topic on your page instead. To identify the Parent Topic, we take the #1 ranking page for your keyword and find the keyword responsible for sending the most traffic to that page.

positioninteger or null

The top position (or target URL’s, if set) in organic search.

position_diffinteger or null

The change in top position (or target URL’s, if set) between selected dates.

position_previnteger or null

The top position (or target URL’s, if set) on the comparison date.

search_type_imagenumber (float) or null

Search type Image shows the percentage of searches for a keyword made for images, highlighting interest in visual content.

search_type_newsnumber (float) or null

Search type News shows the percentage of searches for a keyword made for news articles.

search_type_videonumber (float) or null

Search type Video shows the percentage of searches for a keyword made for video, reflecting interest in video content.

search_type_webnumber (float) or null

Search type Web shows the percentage of searches for a keyword made for general web content, indicating interest in a wide range of information.

serp_featuresarray<string>

The SERP features that appear in search results for a keyword.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shoppingimage_thvideo_thai_overview_found
serp_features_prevarray<string>

The SERP features that appear in search results for a keyword on the comparison date.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shoppingimage_thvideo_thai_overview_found
serp_updatedstring (date-time) or null

The date when we last checked search engine results for a keyword.

serp_updated_prevstring (date-time) or null

The date when we checked search engine results up to the comparison date.

tagsarray<string>

A list of tags assigned to a given keyword.

tags_prevarray<string>

A list of tags assigned to a given keyword on the comparison date.

target_positions_countinteger

The number of target URLs ranking for a keyword.

trafficinteger or null

An estimation of the number of monthly visits that a page gets from organic search over the latest month or over the latest known 12 months of data depending on the "volume_mode" parameter.

traffic_diffinteger or null

The change in traffic between your selected dates.

traffic_previnteger or null

An estimation of the number of monthly visits that a page gets from organic search over the latest month or over the latest known 12 months of data depending on the "volume_mode" parameter.

urlstring (url) or null

The top-ranking URL (or target URL, if set) in organic search.

url_prevstring (url) or null

The top-ranking URL (or target URL, if set) on the comparison date.

volumeinteger or null

An estimation of the average monthly number of searches for a keyword over the latest month or over the latest known 12 months of data depending on the "volume_mode" parameter.

volume_desktop_pctnumber (float) or null

The percentage of the total search volume that comes from desktop devices.

volume_mobile_pctnumber (float) or null

The percentage of the total search volume that comes from mobile devices.