Rank Tracker

Overview

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

get/rank-tracker/overview

Request

  • Base URL
    https://api.ahrefs.com/v3
  • URL
    https://api.ahrefs.com/v3/rank-tracker/overview
  • Auth
    HTTP bearer

Query parameters

selectstring required

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

wherestring

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

best_position_has_thumbnail: The top position (or target URL’s, if set) has a thumbnail.
type: boolean nullable

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

best_position_has_video_preview: The top position (or target URL’s, if set) has a video preview.
type: boolean nullable

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

best_position_kind: The kind of top position (or target URL’s, if set): organic, paid, or a SERP feature.
type: string nullable
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "ai_overview" "ai_overview_sitelink" "organic_shopping"

best_position_kind_previous: The kind of top position (or target URL’s, if set) on the comparison date.
type: string nullable
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "ai_overview" "ai_overview_sitelink" "organic_shopping"

clicks: 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.
type: integer nullable

clicks_per_search: 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.
type: float nullable

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

country: The country that a given keyword is being tracked in. A two-letter country code (ISO 3166-1 alpha-2).
type: string
enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "OTHER" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

country_prev: The country that a given keyword is being tracked in on the comparison date. A two-letter country code (ISO 3166-1 alpha-2).
type: string
enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "OTHER" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

created_at: The date when a keyword was added to the project.
type: datetime

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

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

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

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

is_main_position: Excludes positions in Ai Overview, Sitelinks, Top stories, Image packs, Videos, Discussions and forums, and posts on X (Twitter).
type: boolean

is_main_position_prev: Excludes positions in Ai Overview, Sitelinks, Top stories, Image packs, Videos, Discussions and forums, and posts on X (Twitter) on the comparison date.
type: boolean

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

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

keyword: The keyword your target ranks for.
type: string

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

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

keyword_is_frozen: 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.
type: boolean

keyword_prev: The keyword your target ranks for on the comparison date.
type: string

keyword_words: The number of words in a keyword.
type: integer

keyword_words_prev: The number of words in a keyword on the comparison date.
type: integer

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

language_prev: The SERP language on the comparison date.
type: string

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

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

parent_topic: 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.
type: string nullable

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

position_diff: The change in top position (or target URL’s, if set) between selected dates.
type: integer nullable

position_prev: The top position (or target URL’s, if set) on the comparison date.
type: integer nullable

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

search_type_news: Search type News shows the percentage of searches for a keyword made for news articles.
type: float nullable

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

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

serp_features: The SERP features that appear in search results for a keyword.
type: array(string)
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "ai_overview" "ai_overview_sitelink" "organic_shopping" "image_th" "video_th" "ai_overview_found"

serp_features_prev: The SERP features that appear in search results for a keyword on the comparison date.
type: array(string)
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "ai_overview" "ai_overview_sitelink" "organic_shopping" "image_th" "video_th" "ai_overview_found"

serp_updated: The date when we last checked search engine results for a keyword.
type: datetime nullable

serp_updated_prev: The date when we checked search engine results up to the comparison date.
type: datetime nullable

tags: A list of tags assigned to a given keyword.
type: array(string)

tags_prev: A list of tags assigned to a given keyword on the comparison date.
type: array(string)

target_positions_count: The number of target URLs ranking for a keyword.
type: integer

traffic: 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.
type: integer nullable

traffic_diff: The change in traffic between your selected dates.
type: integer nullable

traffic_prev: 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.
type: integer nullable

url: The top-ranking URL (or target URL, if set) in organic search.
type: string nullable

url_prev: The top-ranking URL (or target URL, if set) on the comparison date.
type: string nullable

volume: 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.
type: integer nullable

volume_desktop_pct: The percentage of the total search volume that comes from desktop devices.
type: float nullable

volume_mobile_pct: The percentage of the total search volume that comes from mobile devices.
type: float nullable

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

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

limitinteger

The number of results to return.

timeoutinteger

A manual timeout duration in seconds.

volume_mode'monthly' | 'average'

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

project_idinteger required

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#

device'desktop' | 'mobile' required

Choose between mobile and desktop rankings.

datestring date required

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

date_comparedstring date

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

output'json' | 'csv' | 'xml' | 'php'

The output format.

Response

OK

Changes

No recorded changes to this operation across all 26 revisions of this API.