Ahrefs

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

The scope of the search based on the target you entered.

The output format.

The target of the search: a domain or a URL.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

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

A two-letter country code (ISO 3166-1 alpha-2).

A list of targets to do batch analysis.

A column to order results by. See response schema for valid column identifiers.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The output format.

The target of the search: a domain or a URL.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

The target of the search: a domain or a URL.

The end date of the historical period in YYYY-MM-DD format.

The start date of the historical period in YYYY-MM-DD format.

The time interval used to group historical data.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **clicks**: The average monthly number of clicks on the search results that people make while searching for the target keyword. type: integer nullable **cpc**: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents. type: integer nullable **cps**: Clicks Per Search (or CPS) 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 **difficulty** (10 units): 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 **first_seen**: The date when we first checked search engine results for a keyword. type: datetime nullable **global_volume** (10 units): How many times per month, on average, people search for the target keyword across all countries in our database. type: integer nullable **intents** (10 units): Indicates the purpose behind the user"s search query. Object fields: `informational`, `navigational`, `commercial`, `transactional`, `branded` or `local`. All the fields are of type `bool`, with posible values `true` or `false`. type: object nullable **keyword**: 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 **parent_volume** (10 units): The search volume of the parent topic. type: integer nullable **serp_domain_rating_top10_min**: The keyword must have at least one ranking position in the top 10 results with a DR of up to this value. type: float nullable **serp_domain_rating_top5_min**: The keyword must have at least one ranking position in the top 5 results with a DR of up to this value. type: float nullable **serp_features**: The enriched results on a search engine results page (SERP) that are not traditional organic results. type: array(string) enum: `"ai_overview_sitelink"` `"snippet"` `"ai_overview"` `"local_pack"` `"sitelink"` `"news"` `"image"` `"video"` `"discussion"` `"tweet"` `"paid_top"` `"paid_bottom"` `"paid_sitelink"` `"shopping"` `"knowledge_card"` `"knowledge_panel"` `"question"` `"image_th"` `"video_th"` `"organic_shopping"` **serp_last_update**: The date when we last checked search engine results for a keyword. type: datetime nullable **traffic_potential** (10 units): The sum of organic traffic that the #1 ranking page for your target keyword receives from all the keywords that it ranks for. type: integer nullable **volume** (10 units): An estimation of the average monthly number of searches for a keyword over the latest known 12 months of data. type: integer nullable **volume_desktop_pct**: The percentage of searches for a keyword performed on desktop devices. type: float nullable **volume_mobile_pct**: The percentage of searches for a keyword performed on mobile devices. type: float nullable **word_count**: type: integer

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A comma-separated list of keywords to show metrics for.

A column to order results by. See response schema for valid column identifiers.

The scope of the target URL you specified.

[Deprecated on 5 Aug 2024].

The id of an existing keyword list to show metrics for.

Filters keywords based on the ranking position of the specified `target`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of results to return.

The output format.

The keyword to show metrics for.

[Deprecated on 5 Aug 2024].

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **anchor**: The clickable words in a link that point to a URL. type: string **dofollow_linked_domains**: The number of unique root domains with dofollow links linked from the linked domain. type: integer **dofollow_links**: The number of links from your target to the linked domain that don"t have the "nofollow" attribute. type: integer **dofollow_refdomains** (5 units): The number of unique domains with dofollow links to the linked domain. type: integer **domain**: A linked domain that has at least one link from your target. type: string **domain_rating**: The strength of a domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **first_seen**: The date we first found a link to the linked domain from your target. type: datetime **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_root_domain**: The domain name is a root domain name. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **languages**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **len_url_redirect**: The number of redirect chain URLs. type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domain_traffic** (10 units): The linked domain"s estimated monthly organic traffic from search type: integer **linked_domains**: The number of unique root domains linked from the referring page. type: integer **linked_pages**: The number of the domain"s pages linked from your target. type: integer **links_external**: The number of external links from the referring page. type: integer **links_from_target**: The number of links to the linked domain from your target. type: integer **port_source**: The network port of the referring page URL. type: integer **port_target**: The network port of the target page URL. type: integer **positions**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **powered_by**: Web technologies used to build and serve the referring page content. type: array(string) **refdomains** (5 units): The number of unique referring domains linking to the referring page. type: integer **root_domain_name**: The root domain name of the referring domain, not including subdomains. type: string **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **title**: The html title of the referring page. type: string **traffic_page** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **url_from**: The URL of the page containing a link from your target. type: string **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the outgoing link points to. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of results to return.

All keywords ideas or keywords ideas phrased as questions.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **cpc**: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents. type: integer nullable **cps**: Clicks Per Search (or CPS) 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 **difficulty** (10 units): 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 **first_seen**: The date when we first checked search engine results for a keyword. type: datetime nullable **global_volume** (10 units): How many times per month, on average, people search for the target keyword across all countries in our database. type: integer nullable **intents** (10 units): Indicates the purpose behind the user"s search query. Object fields: `informational`, `navigational`, `commercial`, `transactional`, `branded` or `local`. All the fields are of type `bool`, with posible values `true` or `false`. type: object nullable **keyword**: 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 **serp_domain_rating_top10_min**: The keyword must have at least one ranking position in the top 10 results with a DR of up to this value. type: float nullable **serp_domain_rating_top5_min**: The keyword must have at least one ranking position in the top 5 results with a DR of up to this value. type: float nullable **serp_features**: The enriched results on a search engine results page (SERP) that are not traditional organic results. type: array(string) enum: `"ai_overview_sitelink"` `"snippet"` `"ai_overview"` `"local_pack"` `"sitelink"` `"news"` `"image"` `"video"` `"discussion"` `"tweet"` `"paid_top"` `"paid_bottom"` `"paid_sitelink"` `"shopping"` `"knowledge_card"` `"knowledge_panel"` `"question"` `"image_th"` `"video_th"` `"organic_shopping"` **serp_last_update**: The date when we last checked search engine results for a keyword. type: datetime nullable **traffic_potential** (10 units): The sum of organic traffic that the #1 ranking page for your target keyword receives from all the keywords that it ranks for. type: integer nullable **volume** (10 units): An estimation of the average monthly number of searches for a keyword over the latest known 12 months of data. type: integer nullable **volume_desktop_pct**: The percentage of searches for a keyword performed on desktop devices. type: float nullable **volume_mobile_pct**: The percentage of searches for a keyword performed on mobile devices. type: float nullable **word_count**: type: integer

[Deprecated on 31 May 2024].

The output format.

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

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A comma-separated list of keywords to show metrics for.

A column to order results by. See response schema for valid column identifiers.

Keyword ideas contain the words from your query in any order (terms mode) or in the exact order they are written (phrase mode).

[Deprecated on 5 Aug 2024].

The id of an existing keyword list to show metrics for.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **ahrefs_rank_source**: The strength of the referring domain"s backlink profile compared to the other websites in our database, with rank #1 being the strongest. type: integer **ahrefs_rank_target**: The strength of the target domain"s backlink profile compared to the other websites in our database, with rank #1 being the strongest. type: integer **alt**: The alt attribute of the link. type: string nullable **anchor**: The clickable words in a link that point to a URL. type: string **broken_redirect_new_target**: The new destination of a modified redirect. type: string nullable **broken_redirect_reason**: The reason the redirect was considered broken during the last crawl. type: string nullable enum: `"droppedmanual"` `"droppedtooold"` `"dropped"` `"codechanged"` `"nxdomain"` `"robotsdisallowed"` `"curlerror"` `"invalidtarget"` `"nomorecanonical"` `"isnowparked"` `"targetchanged"` **broken_redirect_source**: The redirecting URL that was modified, causing the redirect to become broken. type: string nullable **class_c** (5 units): The number of unique class_c subnets linking to the referring page. type: integer **discovered_status**: The reason the link was discovered during the last crawl: the page was crawled for the first time, the link was added to the page, or the link re-appeared after being removed. type: string nullable enum: `"pagefound"` `"linkfound"` `"linkrestored"` **domain_rating_source**: The strength of the referring domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **domain_rating_target**: The strength of the referring domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **drop_reason**: The reason we removed the link from our index. type: string nullable enum: `"manual"` `"noratingunused"` `"notop"` `"tooold"` `"oldunavailable"` `"rescursive"` `"duplicate"` `"nxdomain"` `"malformed"` `"blockedport"` `"disallowed"` `"unlinked"` **encoding**: The character set encoding of the referring page HTML. type: string **first_seen**: The date the referring page URL was first discovered. type: datetime **first_seen_link**: The date we first found a backlink to your target on a given referring page. type: datetime **http_code**: The return code from HTTP protocol returned during the referring page crawl. type: integer **http_crawl**: The link was discovered without executing javascript and rendering the page. type: boolean **ip_source**: The referring domain IP address. type: string nullable **is_alternate**: The link with the rel=“alternate” attribute. type: boolean **is_canonical**: The link with the rel=“canonical” attribute. type: boolean **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_form**: The link was found in a form HTML tag. type: boolean **is_frame**: The link was found in an iframe HTML tag. type: boolean **is_homepage_link**: The link was found on the homepage of a referring website. type: boolean **is_image**: The link is a regular link that has an image inside their href attribute. type: boolean **is_lost**: The link currently does not exist anymore. type: boolean **is_new**: The link was discovered on the last crawl. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_redirect**: The link pointing to your target via a redirect. type: boolean **is_redirect_lost**: The redirected link currently does not exist anymore. type: boolean **is_root_source**: The referring domain name is a root domain name. type: boolean **is_root_target**: The target domain name is a root domain name. type: boolean **is_rss**: The link was found in an RSS feed. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_text**: The link is a standard href hyperlink. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **js_crawl**: The link was discovered after executing javascript and rendering the page. type: boolean **languages**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **last_seen**: The date we discovered that the link was lost. type: datetime nullable **last_visited**: The date we last verified a live link to your target page. type: datetime **len_url_redirect**: The number of redirect chain URLs. type: integer **link_group_count**: The number of backlinks that were grouped together based on the aggregation parameter. This field cannot be used with aggregation "all". type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains_source_domain**: The number of unique root domains linked from the referring domain. type: integer **linked_domains_source_page**: The number of unique root domains linked from the referring page. type: integer **linked_domains_target_domain**: The number of unique root domains linked from the target domain. type: integer **links_external**: The number of external links from the referring page. type: integer **links_internal**: The number of internal links from the referring page. type: integer **lost_reason**: The reason the link was lost during the last crawl. type: string nullable enum: `"removedfromhtml"` `"notcanonical"` `"noindex"` `"pageredirected"` `"pageerror"` `"lostredirect"` `"notfound"` **name_source**: The complete referring domain name, including subdomains. type: string **name_target**: The complete target domain name, including subdomains. type: string **noindex**: The referring page has the noindex meta attribute. type: boolean **page_size**: The size in bytes of the referring page content. type: integer **port_source**: The network port of the referring page URL. type: integer **port_target**: The network port of the target page URL. type: integer **positions**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **positions_source_domain**: The number of keywords that the referring domain ranks for in the top 100 positions. type: integer **powered_by**: Web technologies used to build and serve the referring page content. type: array(string) **redirect_code**: The HTTP status code of a referring page pointing to your target via a redirect. type: integer nullable **redirect_kind**: The HTTP status codes returned by the target redirecting URL or redirect chain. type: array(integer) **refdomains_source** (5 units): The number of unique referring domains linking to the referring page. type: integer **refdomains_source_domain** (5 units): The number of unique referring domains linking to the referring domain. type: integer **refdomains_target_domain** (5 units): The number of unique referring domains linking to the target domain. type: integer **root_name_source**: The root domain name of the referring domain, not including subdomains. type: string **root_name_target**: The root domain name of the target domain, not including subdomains. type: string **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **source_page_author**: The author of the referring page. type: string nullable **source_page_publish_date**: the date we identified the page was published type: date nullable **title**: The html title of the referring page. type: string **tld_class_source**: The top level domain class of the referring domain. type: string enum: `"gov"` `"edu"` `"normal"` **tld_class_target**: The top level domain class of the target domain. type: string enum: `"gov"` `"edu"` `"normal"` **traffic** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **traffic_domain** (10 units): The referring domain"s estimated monthly organic traffic from search. type: integer **url_from**: The URL of the page containing a link to your target. type: string **url_from_plain**: The referring page URL optimized for use as a filter. type: string **url_rating_source**: The strength of the referring page"s backlink profile compared to the others in our database on a 100-point scale. type: float **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string **url_to_plain**: The target page URL optimized for use as a filter. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A time frame to add lost backlinks to the report. Choose between `live` (no history), `since:<date>` (history since a specified date), and `all_time` (full history). The date should be in YYYY-MM-DD format.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

The backlinks grouping mode.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **ahrefs_rank_source**: The strength of the referring domain"s backlink profile compared to the other websites in our database, with rank #1 being the strongest. type: integer **ahrefs_rank_target**: The strength of the target domain"s backlink profile compared to the other websites in our database, with rank #1 being the strongest. type: integer **alt**: The alt attribute of the link. type: string nullable **anchor**: The clickable words in a link that point to a URL. type: string **class_c** (5 units): The number of unique class_c subnets linking to the referring page. type: integer **domain_rating_source**: The strength of the referring domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **domain_rating_target**: The strength of the referring domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **encoding**: The character set encoding of the referring page HTML. type: string **first_seen**: The date the referring page URL was first discovered. type: datetime **first_seen_link**: The date we first found a backlink to your target on a given referring page. type: datetime **http_code**: The return code from HTTP protocol returned during the referring page crawl. type: integer **http_code_target**: The return code from HTTP protocol returned during the target page crawl. type: integer nullable **http_crawl**: The link was discovered without executing javascript and rendering the page. type: boolean **ip_source**: The referring domain IP address. type: string nullable **is_alternate**: The link with the rel=“alternate” attribute. type: boolean **is_canonical**: The link with the rel=“canonical” attribute. type: boolean **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_form**: The link was found in a form HTML tag. type: boolean **is_frame**: The link was found in an iframe HTML tag. type: boolean **is_homepage_link**: The link was found on the homepage of a referring website. type: boolean **is_image**: The link is a regular link that has an image inside their href attribute. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_redirect**: The link pointing to your target via a redirect. type: boolean **is_root_source**: The referring domain name is a root domain name. type: boolean **is_root_target**: The target domain name is a root domain name. type: boolean **is_rss**: The link was found in an RSS feed. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_text**: The link is a standard href hyperlink. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **js_crawl**: The link was discovered after executing javascript and rendering the page. type: boolean **languages**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **last_seen**: The date we discovered that the link was lost. type: datetime nullable **last_visited**: The date we last re-crawled the referring page to verify the backlink is alive. type: datetime **last_visited_target**: The date we last re-crawled the target page to verify that it is broken. type: datetime nullable **len_url_redirect**: The number of redirect chain URLs. type: integer **link_group_count**: The number of backlinks that were grouped together based on the aggregation parameter. This field cannot be used with aggregation "all". type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains_source_domain**: The number of unique root domains linked from the referring domain. type: integer **linked_domains_source_page**: The number of unique root domains linked from the referring page. type: integer **linked_domains_target_domain**: The number of unique root domains linked from the target domain. type: integer **links_external**: The number of external links from the referring page. type: integer **links_internal**: The number of internal links from the referring page. type: integer **name_source**: The complete referring domain name, including subdomains. type: string **name_target**: The complete target domain name, including subdomains. type: string **page_size**: The size in bytes of the referring page content. type: integer **port_source**: The network port of the referring page URL. type: integer **port_target**: The network port of the target page URL. type: integer **positions**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **positions_source_domain**: The number of keywords that the referring domain ranks for in the top 100 positions. type: integer **powered_by**: Web technologies used to build and serve the referring page content. type: array(string) **redirect_code**: The HTTP status code of a referring page pointing to your target via a redirect. type: integer nullable **redirect_kind**: The HTTP status codes returned by the target redirecting URL or redirect chain. type: array(integer) **refdomains_source** (5 units): The number of unique referring domains linking to the referring page. type: integer **refdomains_source_domain** (5 units): The number of unique referring domains linking to the referring domain. type: integer **refdomains_target_domain** (5 units): The number of unique referring domains linking to the target domain. type: integer **root_name_source**: The root domain name of the referring domain, not including subdomains. type: string **root_name_target**: The root domain name of the target domain, not including subdomains. type: string **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **source_page_author**: The author of the referring page. type: string nullable **title**: The html title of the referring page. type: string **tld_class_source**: The top level domain class of the referring domain. type: string enum: `"gov"` `"edu"` `"normal"` **tld_class_target**: The top level domain class of the target domain. type: string enum: `"gov"` `"edu"` `"normal"` **traffic** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **traffic_domain** (10 units): The referring domain"s estimated monthly organic traffic from search. type: integer **url_from**: The URL of the page containing a link to your target. type: string **url_from_plain**: The referring page URL optimized for use as a filter. type: string **url_rating_source**: The strength of the referring page"s backlink profile compared to the others in our database on a 100-point scale. type: float **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string **url_to_plain**: The target page URL optimized for use as a filter. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

The backlinks grouping mode.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **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"` **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 **language**: The SERP language that a given keyword is being tracked for. type: string **location**: The location (country, state/province, or city) that a given keyword is being tracked in. type: string **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_updated**: The date when we last checked search engine results for a keyword. type: datetime nullable **tags**: A list of tags assigned to a given keyword. type: array(string) **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

Choose between mobile and desktop rankings.

[Deprecated on 31 May 2024].

The output format.

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

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

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#`

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The number of results to return.

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 has a thumbnail. type: boolean nullable **best_position_has_thumbnail_previous**: The top position has a thumbnail on the comparison date. type: boolean nullable **best_position_has_video_preview**: The top position has a video preview. type: boolean nullable **best_position_has_video_preview_previous**: The top position has a video preview on the comparison date. type: boolean nullable **best_position_kind**: The kind of the top position: 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 the top position 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"` **is_main_position**: Excludes positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter). type: boolean **is_main_position_prev**: Excludes positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter) on the comparison date. 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 your target ranks for in the organic search results for a keyword. type: integer nullable **position_diff**: The change in position between your selected dates. type: integer nullable **position_prev**: The top position 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_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 in organic search results for a given keyword. type: string nullable **url_prev**: The top ranking URL in organic search results for a given keyword 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

Choose between mobile and desktop rankings.

[Deprecated on 31 May 2024].

The output format.

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

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

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#`

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **anchor**: The clickable words in a link that point to a URL. type: string **discovered_status**: The reason the link was discovered during the last crawl: the page was crawled for the first time, the link was added to the page, or the link re-appeared after being removed. type: string nullable enum: `"pagefound"` `"linkfound"` `"linkrestored"` **dofollow_linked_domains**: The number of unique root domains with dofollow links linked from the referring domain. type: integer **dofollow_links**: The number of links from the referring domain to your target that don"t have the "nofollow" attribute. type: integer **dofollow_refdomains** (5 units): The number of unique domains with dofollow links to the referring domain. type: integer **domain**: A referring domain that has at least one link to your target. type: string **domain_rating**: The strength of a domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **drop_reason**: The reason we removed the link from our index. type: string nullable enum: `"manual"` `"noratingunused"` `"notop"` `"tooold"` `"oldunavailable"` `"rescursive"` `"duplicate"` `"nxdomain"` `"malformed"` `"blockedport"` `"disallowed"` `"unlinked"` **first_seen**: The date we first found a backlink to your target from the referring domain. type: datetime **ip_source**: The referring domain IP address. type: string nullable **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_homepage_link**: The link was found on the homepage of a referring website. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_root_domain**: The domain name is a root domain name. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **languages**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **last_seen**: The date your target lost its last live backlink for the referring domain. type: datetime nullable **len_url_redirect**: The number of redirect chain URLs. type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains**: The number of unique root domains linked from the referring page. type: integer **links_external**: The number of external links from the referring page. type: integer **links_to_target**: The number of backlinks from the referring domain to your target. type: integer **lost_links**: The number of backlinks lost from the referring domain for the selected time period. type: integer **lost_reason**: The reason the link was lost during the last crawl. type: string nullable enum: `"removedfromhtml"` `"notcanonical"` `"noindex"` `"pageredirected"` `"pageerror"` `"lostredirect"` `"notfound"` **new_links**: The number of new backlinks found from the referring domain for the selected time period. type: integer **noindex**: The referring page has the noindex meta attribute. type: boolean **port_source**: The network port of the referring page URL. type: integer **port_target**: The network port of the target page URL. type: integer **positions**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **positions_source_domain**: The number of keywords that the referring domain ranks for in the top 100 positions. type: integer **powered_by**: Web technologies used to build and serve the referring page content. type: array(string) **refdomains** (5 units): The number of unique referring domains linking to the referring page. type: integer **root_domain_name**: The root domain name of the referring domain, not including subdomains. type: string **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **source_page_author**: The author of the referring page. type: string nullable **title**: The html title of the referring page. type: string **traffic_domain** (10 units): The referring domain"s estimated monthly organic traffic from search. type: integer **traffic_page** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **url_from**: The URL of the page containing a link to your target. type: string **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A time frame to add lost backlinks to the report. Choose between `live` (no history), `since:<date>` (history since a specified date), and `all_time` (full history). The date should be in YYYY-MM-DD format.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The output format.

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

The end date of the historical period in YYYY-MM-DD format.

The protocol of your target.

The start date of the historical period in YYYY-MM-DD format.

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

The number of top organic search positions to consider when calculating total search volume.

The time interval used to group historical data.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A timestamp on which the last available SERP Overview is returned in YYYY-MM-DDThh:mm:ss format. If it is not specified, the most recent SERP Overview is returned.

The output format.

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

A two-letter country code (ISO 3166-1 alpha-2).

The keyword to return SERP Overview for.

The number of top organic SERP positions to return. If not specified, all available positions will be returned.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The scope of the search based on the target you entered.

The number of results to return.

The output format.

The target of the search: a domain or a URL.

The protocol of your target.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **anchor**: The clickable words in a link that point to a URL. type: string **dofollow_links**: The number of outbound links with a given anchor from your target that don’t have the “nofollow” attribute. type: integer **domain**: A linked domain that has at least one link from your target with a given anchor. type: string **domain_rating**: The strength of a domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **first_seen**: The date we first found a link with a given anchor on your target. type: datetime **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **languages**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **len_url_redirect**: The number of redirect chain URLs. type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains**: The number of unique domains linked from your target with a given anchor. type: integer **linked_domains_source**: The number of unique root domains linked from the source page. type: integer **linked_pages**: The number of unique pages linked from your target with a given anchor. type: integer **links_external**: The number of external links from the referring page. type: integer **links_from_target**: The number of outbound links your target has with a given anchor. type: integer **port_source**: The network port of the referring page URL. type: integer **port_target**: The network port of the target page URL. type: integer **positions**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **powered_by**: Web technologies used to build and serve the referring page content. type: array(string) **refdomains_source** (5 units): The number of unique referring domains linking to the referring page. type: integer **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **title**: The html title of the referring page. type: string **traffic_page** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **url_from**: The URL of the page containing a link to your target. type: string **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

The target of the search: a domain or a URL.

The end date of the historical period in YYYY-MM-DD format.

The start date of the historical period in YYYY-MM-DD format.

The time interval used to group historical data.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **anchor**: The clickable words in a link that point to a URL. type: string **dofollow_links**: The number of outbound links with a given anchor from your target that don’t have the “nofollow” attribute. type: integer **domain**: A linked domain that has at least one link from your target with a given anchor. type: string **domain_rating**: The strength of a domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **first_seen**: The date we first found a link with a given anchor on your target. type: datetime **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **languages**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **len_url_redirect**: The number of redirect chain URLs. type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains_source**: The number of unique root domains linked from the source page. type: integer **linked_pages**: The number of unique pages linked from your target with a given anchor. type: integer **links_external**: The number of external links from the referring page. type: integer **links_from_target**: The number of outbound links your target has with a given anchor. type: integer **port_source**: The network port of the referring page URL. type: integer **port_target**: The network port of the target page URL. type: integer **positions**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **powered_by**: Web technologies used to build and serve the referring page content. type: array(string) **refdomains_source** (5 units): The number of unique referring domains linking to the referring page. type: integer **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **title**: The html title of the referring page. type: string **traffic_page** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **url_from**: The URL of the page containing a link to your target. type: string **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **anchor**: The clickable words in a link that point to a URL. type: string **dofollow_to_target**: The number of links to your target page that don’t have the “nofollow” attribute. type: integer **domain_rating_source**: The strength of the referring domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **first_seen_link**: The date we first found a link to your target. type: datetime **http_code_source**: The return code from HTTP protocol returned during the referring page crawl. type: integer **http_code_target**: The return code from HTTP protocol returned during the target page crawl. type: integer nullable **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_homepage_link**: The link was found on the homepage of a referring website. type: boolean **is_lost**: The link currently does not exist anymore. type: boolean **is_new**: The link was discovered on the last crawl. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_root_source**: The referring domain name is a root domain name. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **languages_source**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **languages_target**: The languages listed in the target page metadata or detected by the crawler to appear in the HTML. type: array(string) **last_seen**: The date your target page lost its last live link. type: datetime nullable **last_visited_source**: The date we last verified a live link to your target page. type: datetime **last_visited_target**: The date we last crawled your target page. type: datetime nullable **len_url_redirect**: The number of redirect chain URLs. type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains_source**: The number of unique root domains linked from the referring page. type: integer **links_external_source**: The number of external links from the referring page. type: integer **links_to_target**: The number of inbound backlinks the target page has. type: integer **lost_links_to_target**: The number of backlinks lost during the selected time period. type: integer **new_links_to_target**: The number of new backlinks found during the selected time period. type: integer **nofollow_to_target**: The number of links to your target page that have the “nofollow” attribute. type: integer **positions_source**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **positions_source_domain**: The number of keywords that the referring domain ranks for in the top 100 positions. type: integer **powered_by_source**: Web technologies used to build and serve the referring page content. type: array(string) **powered_by_target**: Web technologies used to build and serve the target page content. type: array(string) **redirects_to_target**: The number of inbound redirects to your target page. type: integer **refdomains_source** (5 units): The number of unique referring domains linking to the referring page. type: integer **refdomains_target** (5 units): The number of unique referring domains linking to the target page. type: integer **root_name_source**: The root domain name of the referring domain, not including subdomains. type: string **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **source_page_author**: The author of the referring page. type: string nullable **target_redirect**: The target"s redirect if any. type: string nullable **title_source**: The html title of the referring page. type: string **title_target**: The html title of the target page. type: string nullable **top_domain_rating_source**: The highest Domain Rating (DR) counted out of all referring domains. DR shows the strength of a website’s backlink profile compared to the others in our database on a 100-point scale. type: float **traffic_domain_source** (10 units): The referring domain"s estimated monthly organic traffic from search. type: integer **traffic_source** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **url_from_plain**: The referring page URL optimized for use as a filter. type: string **url_rating_source**: The strength of the referring page"s backlink profile compared to the others in our database on a 100-point scale. type: float **url_rating_target**: The strength of the target page"s backlink profile compared to the others in our database on a 100-point scale. type: float nullable **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string **url_to_plain**: The target page URL optimized for use as a filter. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A time frame to add lost backlinks to the report. Choose between `live` (no history), `since:<date>` (history since a specified date), and `all_time` (full history). The date should be in YYYY-MM-DD format.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The output format.

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

The protocol of your target.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **anchor**: The clickable words in a link that point to a URL. type: string **discovered_status**: The reason the link was discovered during the last crawl: the page was crawled for the first time, the link was added to the page, or the link re-appeared after being removed. type: string nullable enum: `"pagefound"` `"linkfound"` `"linkrestored"` **dofollow_links**: The number of links with a given anchor to your target that don"t have the "nofollow" attribute. type: integer **domain_rating**: The strength of a domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **drop_reason**: The reason we removed the link from our index. type: string nullable enum: `"manual"` `"noratingunused"` `"notop"` `"tooold"` `"oldunavailable"` `"rescursive"` `"duplicate"` `"nxdomain"` `"malformed"` `"blockedport"` `"disallowed"` `"unlinked"` **first_seen**: The date we first found a link with a given anchor to your target. type: datetime **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_homepage_link**: The link was found on the homepage of a referring website. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_root_domain**: The domain name is a root domain name. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **languages**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **last_seen**: The date we discovered the last backlink with a given anchor was lost. type: datetime nullable **len_url_redirect**: The number of redirect chain URLs. type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains**: The number of unique root domains linked from the referring page. type: integer **links_external**: The number of external links from the referring page. type: integer **links_to_target**: The number of inbound backlinks your target has with a given anchor. type: integer **lost_links**: The number of backlinks with a given anchor lost during the selected time period. type: integer **lost_reason**: The reason the link was lost during the last crawl. type: string nullable enum: `"removedfromhtml"` `"notcanonical"` `"noindex"` `"pageredirected"` `"pageerror"` `"lostredirect"` `"notfound"` **new_links**: The number of new backlinks with a given anchor found during the selected time period. type: integer **noindex**: The referring page has the noindex meta attribute. type: boolean **positions**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **positions_source_domain**: The number of keywords that the referring domain ranks for in the top 100 positions. type: integer **powered_by**: Web technologies used to build and serve the referring page content. type: array(string) **refdomains** (5 units): The number of unique domains linking to your target with a given anchor. type: integer **refdomains_source** (5 units): The number of unique referring domains linking to the referring page. type: integer **refpages**: The number of pages containing a link with a given anchor to your target. type: integer **root_domain_name**: The root domain name of the referring domain, not including subdomains. type: string **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **source_page_author**: The author of the referring page. type: string nullable **title**: The html title of the referring page. type: string **top_domain_rating**: The highest Domain Rating (DR) counted out of all referring domains. DR shows the strength of a website"s backlink profile compared to the others in our database on a 100-point scale. type: float **traffic_domain** (10 units): The referring domain"s estimated monthly organic traffic from search. type: integer **traffic_page** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **url_from**: The URL of the page containing a link to your target. type: string **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A time frame to add lost backlinks to the report. Choose between `live` (no history), `since:<date>` (history since a specified date), and `all_time` (full history). The date should be in YYYY-MM-DD format.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **anchor**: The clickable words in a link that point to a URL. type: string **canonical_to_target**: The number of inbound canonical links to your target page. type: integer **dofollow_to_target**: The number of links to your target page that don’t have the “nofollow” attribute. type: integer **domain_rating_source**: The strength of the referring domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **first_seen_link**: The date we first found a link to your target. type: datetime **http_code_source**: The return code from HTTP protocol returned during the referring page crawl. type: integer **http_code_target**: The return code from HTTP protocol returned during the target page crawl. type: integer nullable **is_content**: The link was found in the biggest piece of content on the page. type: boolean **is_dofollow**: The link has no special nofollow attribute. type: boolean **is_homepage_link**: The link was found on the homepage of a referring website. type: boolean **is_nofollow**: The link or the referring page has the nofollow attribute set. type: boolean **is_non_html**: The link points to a URL with non-HTML content. type: boolean **is_root_source**: The referring domain name is a root domain name. type: boolean **is_sponsored**: The link has the Sponsored attribute set in the referring page HTML. type: boolean **is_ugc**: The link has the User Generated Content attribute set in the referring page HTML. type: boolean **languages_source**: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML. type: array(string) **languages_target**: The languages listed in the target page metadata or detected by the crawler to appear in the HTML. type: array(string) **last_seen**: The date your target page lost its last live link. type: datetime nullable **last_visited_source**: The date we last verified a live link to your target page. type: datetime **last_visited_target**: The date we last crawled your target page. type: datetime nullable **len_url_redirect**: The number of redirect chain URLs. type: integer **link_type**: The kind of the backlink. type: string enum: `"redirect"` `"frame"` `"text"` `"form"` `"canonical"` `"alternate"` `"rss"` `"image"` **linked_domains_source**: The number of unique root domains linked from the referring page. type: integer **links_external_source**: The number of external links from the referring page. type: integer **links_to_target**: The number of inbound backlinks the target page has. type: integer **nofollow_to_target**: The number of links to your target page that have the “nofollow” attribute. type: integer **positions_source**: The number of keywords that the referring page ranks for in the top 100 positions. type: integer **positions_source_domain**: The number of keywords that the referring domain ranks for in the top 100 positions. type: integer **powered_by_source**: Web technologies used to build and serve the referring page content. type: array(string) **powered_by_target**: Web technologies used to build and serve the target page content. type: array(string) **redirects_to_target**: The number of inbound redirects to your target page. type: integer **refdomains_source** (5 units): The number of unique referring domains linking to the referring page. type: integer **root_name_source**: The root domain name of the referring domain, not including subdomains. type: string **snippet_left**: The snippet of text appearing just before the link. type: string **snippet_right**: The snippet of text appearing just after the link. type: string **source_page_author**: The author of the referring page. type: string nullable **target_redirect**: The target"s redirect if any. type: string nullable **title_source**: The html title of the referring page. type: string **title_target**: The html title of the target page. type: string nullable **traffic_domain_source** (10 units): The referring domain"s estimated monthly organic traffic from search. type: integer **traffic_source** (10 units): The referring page"s estimated monthly organic traffic from search. type: integer **url_from_plain**: The referring page URL optimized for use as a filter. type: string **url_rating_source**: The strength of the referring page"s backlink profile compared to the others in our database on a 100-point scale. type: float **url_rating_target**: The strength of the target page"s backlink profile compared to the others in our database on a 100-point scale. type: float nullable **url_redirect**: A redirect chain the target URL of the link points to. type: array(url) **url_redirect_with_target**: The target URL of the link with its redirect chain. type: array(string) **url_to**: The URL the backlink points to. type: string **url_to_plain**: The target page URL optimized for use as a filter. type: string

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **competitor_domain**: A competitor"s domain of your target in “domains" group mode. type: domain nullable **competitor_url**: A competitor"s URL of your target in pages" group mode. type: url nullable **cpc_competitor**: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents for a competitor. type: integer nullable **cpc_target**: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents for a target. type: integer nullable **domain_rating**: The strength of a domain"s backlink profile compared to the others in our database on a 100-point scale. type: float **group_mode**: To see competing pages instead, use the “exact URL” target mode or “path” target mode if your target doesn"t have multiple pages. type: string enum: `"domains"` `"pages"` **keyword_difficulty_competitor** (10 units): An estimation of how hard it is to rank in the top 10 organic search results for a keyword on a 100-point scale for a competitor. type: integer nullable **keyword_difficulty_target** (10 units): An estimation of how hard it is to rank in the top 10 organic search results for a keyword on a 100-point scale for a target. type: integer nullable **keywords_common**: Organic keywords that both your target and a competitor are ranking for. type: integer **keywords_competitor**: Organic keywords that a competitor is ranking for, but your target isn"t. type: integer **keywords_target**: Organic keywords that your target is ranking for, but a competitor isn"t. type: integer **pages**: The total number of pages from a target ranking in search results. type: integer nullable **pages_diff**: The change in pages between your selected dates. type: integer **pages_merged**: The pages field optimized for sorting. type: integer **pages_prev**: The total number of pages from a target ranking in search results on the comparison date. type: integer nullable **share**: The percentage of common keywords out of the total number of keywords that your target and a competitor both rank for. type: float **traffic** (10 units): 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 **traffic_merged** (10 units): The traffic field optimized for sorting. type: integer **traffic_prev** (10 units): 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 on the comparison date. type: integer nullable **value** (10 units): The estimated value of a page"s monthly organic search traffic, in USD cents. type: integer nullable **value_diff**: The change in value between your selected dates. type: integer **value_merged** (10 units): The value field optimized for sorting. type: integer nullable **value_prev** (10 units): The estimated value of a page"s monthly organic search traffic, in USD cents on the comparison date. type: integer nullable **volume_competitor** (10 units): 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 for a competitor. type: integer nullable **volume_target** (10 units): 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 for a target. type: integer nullable **words_competitor**: The number of words in a keyword for a competitor. type: integer **words_target**: The number of words in a keyword for a target. type: integer

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **best_position**: The top position your target ranks for in the organic search results for a keyword. type: integer nullable **best_position_diff**: The change in position between your selected dates. type: integer nullable **best_position_has_thumbnail**: The top position has a thumbnail. type: boolean nullable **best_position_has_thumbnail_prev**: The top position has a thumbnail on the comparison date. type: boolean nullable **best_position_has_video**: The top position has a video. type: boolean nullable **best_position_has_video_prev**: The top position has a video on the comparison date. type: boolean nullable **best_position_kind**: The kind of the top position: 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_merged**: The kind of the top position optimized for sorting. type: 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"` **best_position_kind_prev**: The kind of the top position 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"` **best_position_prev**: The top position on the comparison date. type: integer nullable **best_position_set**: The ranking group of the top position. type: string enum: `"top_3"` `"top_4_10"` `"top_11_50"` `"top_51_more"` **best_position_set_prev**: The ranking group of the top position on the comparison date. type: string nullable enum: `"top_3"` `"top_4_10"` `"top_11_50"` `"top_51_more"` **best_position_url**: The ranking URL in organic search results. type: string nullable **best_position_url_prev**: The ranking URL on the comparison date. type: string nullable **best_position_url_raw**: The ranking page URL in encoded format. type: string nullable **best_position_url_raw_prev**: The ranking page URL on the comparison date in encoded format. type: string nullable **cpc**: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents. type: integer nullable **cpc_merged**: The CPC field optimized for sorting. type: integer nullable **cpc_prev**: The CPC metric on the comparison date. type: integer nullable **is_best_position_set_top_11_50**: The ranking group of the top position is 11-50. type: boolean **is_best_position_set_top_11_50_prev**: The ranking group of the top position was 11-50 on the comparison date. type: boolean nullable **is_best_position_set_top_3**: The ranking group of the top position is Top 3. type: boolean **is_best_position_set_top_3_prev**: The ranking group of the top position was Top 3 on the comparison date. type: boolean nullable **is_best_position_set_top_4_10**: The ranking group of the top position is 4-10. type: boolean **is_best_position_set_top_4_10_prev**: The ranking group of the top position was 4-10 on the comparison date. type: boolean nullable **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 Sitelinks, Top stories, Image packs, and posts on X (Twitter). type: boolean **is_main_position_prev**: Excludes positions in Sitelinks, Top stories, Image packs, 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** (10 units): 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_difficulty_merged** (10 units): The keyword difficulty field optimized for sorting. type: integer nullable **keyword_difficulty_prev** (10 units): The keyword difficulty on the comparison date. type: integer nullable **keyword_merged**: The keyword field optimized for sorting. type: string **keyword_prev**: The keyword your target ranks for on the comparison date. type: string **language**: The SERP language. type: string **language_prev**: The SERP language on the comparison date. type: string nullable **last_update**: The date when we last checked search engine results for a keyword. type: datetime **last_update_prev**: The date when we checked search engine results up to the comparison date. type: datetime nullable **position_kind**: The kind of a position: organic, paid or a SERP feature. This applies to all positions for a given keyword and URL before picking the top position. type: 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"` **position_kind_prev**: The kind of a position on the comparison date. type: 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"` **positions_kinds**: The kinds of the top positions. 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"` **positions_kinds_prev**: The kinds of the top positions 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_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_count**: The number of SERP features that appear in search results for a keyword. type: integer **serp_features_count_prev**: The number of SERP features on the comparison date. type: integer nullable **serp_features_merged**: The SERP features field optimized for sorting. 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 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_target_main_positions_count**: The number of target URLs ranking for a keyword excluding positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter). type: integer **serp_target_main_positions_count_prev**: The number of target URLs ranking for a keyword excluding positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter) on the comparison date. type: integer nullable **serp_target_positions_count**: The number of target URLs ranking for a keyword. type: integer **serp_target_positions_count_prev**: The number of target URLs ranking for a keyword on the comparison date. type: integer nullable **status**: The status of a page: the new page that just started to rank ("left"), the lost page that disappeared from search results ("right"), or no change ("both"). type: string enum: `"left"` `"right"` `"both"` **sum_paid_traffic** (10 units): An estimation of the number of monthly visits that your target gets from paid search for a keyword. type: integer nullable **sum_traffic** (10 units): An estimation of the number of monthly visitors that your target gets from organic search for a keyword. type: integer nullable **sum_traffic_merged** (10 units): The traffic field optimized for sorting. type: integer **sum_traffic_prev** (10 units): The traffic on the comparison date. type: integer nullable **title**: The title displayed for the page in a keyword"s SERP. type: string **title_prev**: The title displayed for the page in a keyword"s SERP on the comparison date. type: string **volume** (10 units): An estimation of the number of searches for a keyword over the latest month. type: integer nullable **volume_desktop_pct**: The percentage of the total search volume that comes from desktop devices. type: float nullable **volume_merged** (10 units): The search volume field optimized for sorting. type: integer nullable **volume_mobile_pct**: The percentage of the total search volume that comes from mobile devices. type: float nullable **volume_prev** (10 units): The search volume on the comparison date. type: integer nullable **words**: The number of words in a keyword. type: integer **words_merged**: The number of words in a keyword optimized for sorting. type: integer **words_prev**: The number of words in a keyword on the comparison date. type: integer

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The output format.

The target of the search: a domain or a URL.

The protocol of your target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **ads_count**: The number of unique ads with a page. type: integer **ads_count_diff**: The change in ads between your selected dates. type: integer **ads_count_prev**: The number of ads on the comparison date. type: integer **cpc** type: integer nullable **cpc_prev**: The CPC metric on the comparison date. type: integer nullable **description**: The description of an ad as seen in search results. type: string **description_prev**: The description of an ad on the comparison date. type: string **has_thumbnail**: The position has a thumbnail. type: boolean **has_thumbnail_prev**: The position has a thumbnail on the comparison date. type: boolean **has_video**: The position has a video. type: boolean **has_video_prev**: The position has a video on the comparison date. type: boolean **keyword**: The keyword your target ranks for. type: string **keyword_difficulty** (10 units): 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_difficulty_prev** (10 units): The keyword difficulty on the comparison date. type: integer nullable **keyword_prev**: The keyword your target ranks for on the comparison date. type: string **keywords**: The total number of keywords that your target ranks for in paid search results. type: integer **keywords_diff**: The change in keywords between your selected dates. type: integer **keywords_diff_percent**: The change in keywords between your selected dates, in percents. type: integer **keywords_merged**: The total number of keywords optimized for sorting. type: integer **keywords_prev**: The keyword your target ranks for on the comparison date. type: integer **position**: The position your target ranks for in the paid search results for a keyword. type: integer **position_kind**: The kind of a position: organic, paid or a SERP feature. This applies to all positions for a given keyword and URL before picking the top position. type: 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"` **position_kind_prev**: The kind of a position on the comparison date. type: 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"` **position_prev**: The position of your target for a given keyword on the comparison date. type: integer **raw_url**: The ranking page URL in encoded format. type: string **raw_url_prev**: The ranking page URL on the comparison date in encoded format. type: string **serp_features** 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 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"` **status**: The status of a page: the new page that just started to rank in paid results ("left"), the lost page that disappeared from paid results ("right"), or no change ("both"). type: string enum: `"left"` `"right"` `"both"` **sum_traffic** (10 units): An estimation of the monthly paid search traffic that a page gets from all the keywords that it ranks for. type: integer nullable **sum_traffic_merged** (10 units): The paid traffic field optimized for sorting. type: integer **sum_traffic_prev** (10 units): The paid traffic on the comparison date. type: integer nullable **title**: The title of an ad as seen in search results. type: string **title_prev**: The title of an ad on the comparison date. type: string **top_keyword**: The keyword that brings the most paid traffic to a page. type: string nullable **top_keyword_best_position**: The ranking position that a page holds for its top keyword. type: integer nullable **top_keyword_best_position_diff**: The change in the top position between your selected dates. type: integer nullable **top_keyword_best_position_kind**: The kind of the top position: 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"` **top_keyword_best_position_kind_prev**: The kind of the top position 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"` **top_keyword_best_position_prev**: The top position on the comparison date. type: integer nullable **top_keyword_best_position_title**: The title displayed for the page in its top keyword"s SERP. type: string nullable **top_keyword_best_position_title_prev**: The title displayed for the page in its top keyword"s SERP on the comparison date. type: string nullable **top_keyword_country**: The country in which a page ranks for its top keyword. type: string nullable 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"` **top_keyword_country_prev**: The country in which a page ranks for its top keyword on the comparison date. type: string nullable 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"` **top_keyword_prev**: The keyword that brings the most paid traffic to a page on the comparison date. type: string nullable **top_keyword_volume** (10 units): An estimation of the average monthly number of searches for the top keyword over the latest month or over the latest known 12 months of data depending on the "volume_mode" parameter. type: integer nullable **top_keyword_volume_prev** (10 units): The search volume on the comparison date. type: integer nullable **traffic** (10 units): An estimation of the number of monthly visitors that your target gets from paid search for a keyword. type: integer **traffic_diff**: The change in traffic between your selected dates. type: integer **traffic_diff_percent**: The change in traffic between your selected dates, in percents. type: integer **traffic_prev** (10 units): The traffic from a keyword on the comparison date. type: integer **url**: The ranking page URL. type: url nullable **url_prev**: The ranking page URL on the comparison date. type: url nullable **url_visual**: The URL of an ad as seen in search results. type: string **url_visual_prev**: The URL of an ad on the comparison date. type: string **value** (10 units): The estimated cost of a page"s monthly paid search traffic, in USD cents. type: integer nullable **value_diff**: The change in traffic value between your selected dates. type: integer **value_diff_percent**: The change in traffic value between your selected dates, in percents. type: integer **value_merged** (10 units): The traffic value field optimized for sorting. type: integer nullable **value_prev** (10 units): The traffic value on the comparison date. type: integer nullable **volume** (10 units): An estimation of the number of searches for a keyword over the latest month. type: integer nullable **volume_prev** (10 units): The search volume on the comparison date. type: integer nullable **words**: The number of words in a keyword. type: integer **words_prev**: The number of words in a keyword on the comparison date. type: integer

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of results to return.

Related keywords which top-ranking pages also rank for (`also_rank_for`), additional keywords frequently mentioned in top-ranking pages (`also_talk_about`), or combination of both (`all`).

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **cpc**: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents. type: integer nullable **cps**: Clicks Per Search (or CPS) 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 **difficulty** (10 units): 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 **first_seen**: The date when we first checked search engine results for a keyword. type: datetime nullable **global_volume** (10 units): How many times per month, on average, people search for the target keyword across all countries in our database. type: integer nullable **intents** (10 units): Indicates the purpose behind the user"s search query. Object fields: `informational`, `navigational`, `commercial`, `transactional`, `branded` or `local`. All the fields are of type `bool`, with posible values `true` or `false`. type: object nullable **keyword**: 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 **serp_domain_rating_top10_min**: The keyword must have at least one ranking position in the top 10 results with a DR of up to this value. type: float nullable **serp_domain_rating_top5_min**: The keyword must have at least one ranking position in the top 5 results with a DR of up to this value. type: float nullable **serp_features**: The enriched results on a search engine results page (SERP) that are not traditional organic results. type: array(string) enum: `"ai_overview_sitelink"` `"snippet"` `"ai_overview"` `"local_pack"` `"sitelink"` `"news"` `"image"` `"video"` `"discussion"` `"tweet"` `"paid_top"` `"paid_bottom"` `"paid_sitelink"` `"shopping"` `"knowledge_card"` `"knowledge_panel"` `"question"` `"image_th"` `"video_th"` `"organic_shopping"` **serp_last_update**: The date when we last checked search engine results for a keyword. type: datetime nullable **traffic_potential** (10 units): The sum of organic traffic that the #1 ranking page for your target keyword receives from all the keywords that it ranks for. type: integer nullable **volume** (10 units): An estimation of the average monthly number of searches for a keyword over the latest known 12 months of data. type: integer nullable **volume_desktop_pct**: The percentage of searches for a keyword performed on desktop devices. type: float nullable **volume_mobile_pct**: The percentage of searches for a keyword performed on mobile devices. type: float nullable **word_count**: type: integer

[Deprecated on 31 May 2024].

The output format.

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

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A comma-separated list of keywords to show metrics for.

A column to order results by. See response schema for valid column identifiers.

View keywords for the top 10 or top 100 ranking pages.

The id of an existing keyword list to show metrics for.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The output format.

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

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

The end date of the historical period in YYYY-MM-DD format.

The protocol of your target.

The start date of the historical period in YYYY-MM-DD format.

The time interval used to group historical data.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The scope of the search based on the target you entered.

The output format.

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

The protocol of your target.

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The output format.

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

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

The end date of the historical period in YYYY-MM-DD format.

The protocol of your target.

The start date of the historical period in YYYY-MM-DD format.

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

The time interval used to group historical data.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The output format.

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

The end date of the historical period in YYYY-MM-DD format.

The protocol of your target.

The start date of the historical period in YYYY-MM-DD format.

The time interval used to group historical data.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The scope of the search based on the target you entered.

The output format.

The target of the search: a domain or a URL.

The end date of the historical period in YYYY-MM-DD format.

The protocol of your target.

The start date of the historical period in YYYY-MM-DD format.

The time interval used to group historical data.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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

The scope of the search based on the target you entered.

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **cpc** type: integer nullable **cpc_prev**: The CPC metric on the comparison date. type: integer nullable **has_thumbnail**: The position has a thumbnail. type: boolean **has_thumbnail_prev**: The position has a thumbnail on the comparison date. type: boolean **has_video**: The position has a video. type: boolean **has_video_prev**: The position has a video on the comparison date. type: boolean **keyword**: The keyword your target ranks for. type: string **keyword_difficulty** (10 units): 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_difficulty_prev** (10 units): The keyword difficulty on the comparison date. type: integer nullable **keyword_prev**: The keyword your target ranks for on the comparison date. type: string **keywords**: The total number of keywords that your target ranks for in the top 100 organic search results. type: integer **keywords_diff**: The change in keywords between your selected dates. type: integer **keywords_diff_percent**: The change in keywords between your selected dates, in percents. type: integer **keywords_merged**: The total number of keywords optimized for sorting. type: integer **keywords_prev**: The keyword your target ranks for on the comparison date. type: integer **position**: The position your target ranks for in the organic search results for a keyword. type: integer **position_kind**: The kind of a position: organic, paid or a SERP feature. This applies to all positions for a given keyword and URL before picking the top position. type: 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"` **position_kind_prev**: The kind of a position on the comparison date. type: 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"` **position_prev**: The position of your target for a given keyword on the comparison date. type: integer **raw_url**: The ranking page URL in encoded format. type: string **raw_url_prev**: The ranking page URL on the comparison date in encoded format. type: string **serp_features** 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 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"` **status**: The status of a page: the new page that just started to rank ("left"), the lost page that disappeared from search results ("right"), or no change ("both"). type: string enum: `"left"` `"right"` `"both"` **sum_traffic** (10 units): An estimation of the monthly organic search traffic that a page gets from all the keywords that it ranks for. type: integer nullable **sum_traffic_merged** (10 units): The traffic field optimized for sorting. type: integer **sum_traffic_prev** (10 units): The traffic on the comparison date. type: integer nullable **top_keyword**: The keyword that brings the most organic traffic to a page. type: string nullable **top_keyword_best_position**: The ranking position that a page holds for its top keyword. type: integer nullable **top_keyword_best_position_diff**: The change in the top position between your selected dates. type: integer nullable **top_keyword_best_position_kind**: The kind of the top position: 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"` **top_keyword_best_position_kind_prev**: The kind of the top position 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"` **top_keyword_best_position_prev**: The top position on the comparison date. type: integer nullable **top_keyword_best_position_title**: The title displayed for the page in its top keyword"s SERP. type: string nullable **top_keyword_best_position_title_prev**: The title displayed for the page in its top keyword"s SERP on the comparison date. type: string nullable **top_keyword_country**: The country in which a page ranks for its top keyword. type: string nullable 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"` **top_keyword_country_prev**: The country in which a page ranks for its top keyword on the comparison date. type: string nullable 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"` **top_keyword_prev**: The keyword that brings the most organic traffic to a page on the comparison date. type: string nullable **top_keyword_volume** (10 units): An estimation of the average monthly number of searches for the top keyword over the latest month or over the latest known 12 months of data depending on the "volume_mode" parameter. type: integer nullable **top_keyword_volume_prev** (10 units): The search volume on the comparison date. type: integer nullable **traffic** (10 units): An estimation of the number of monthly visitors that your target gets from organic search for a keyword. type: integer **traffic_diff**: The change in traffic between your selected dates. type: integer **traffic_diff_percent**: The change in traffic between your selected dates, in percents. type: integer **traffic_prev** (10 units): The traffic from a keyword on the comparison date. type: integer **url**: The ranking page URL. type: url nullable **url_prev**: The ranking page URL on the comparison date. type: url nullable **value** (10 units): The estimated value of a page"s monthly organic search traffic, in USD cents. type: integer nullable **value_diff**: The change in traffic value between your selected dates. type: integer **value_diff_percent**: The change in traffic value between your selected dates, in percents. type: integer **value_merged** (10 units): The traffic value field optimized for sorting. type: integer nullable **value_prev** (10 units): The traffic value on the comparison date. type: integer nullable **volume** (10 units): An estimation of the number of searches for a keyword over the latest month. type: integer nullable **volume_prev** (10 units): The search volume on the comparison date. type: integer nullable **words**: The number of words in a keyword. type: integer **words_prev**: The number of words in a keyword on the comparison date. type: integer

[Deprecated on 31 May 2024].

The output format.

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

The target of the search: a domain or a URL.

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A column to order results by. See response schema for valid column identifiers.

The protocol of your target.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The output format.

A two-letter country code (ISO 3166-1 alpha-2).

The keyword to show metrics for.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of results to return.

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the `select` parameter). **cpc**: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents. type: integer nullable **cps**: Clicks Per Search (or CPS) 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 **difficulty** (10 units): 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 **first_seen**: The date when we first checked search engine results for a keyword. type: datetime nullable **global_volume** (10 units): How many times per month, on average, people search for the target keyword across all countries in our database. type: integer nullable **intents** (10 units): Indicates the purpose behind the user"s search query. Object fields: `informational`, `navigational`, `commercial`, `transactional`, `branded` or `local`. All the fields are of type `bool`, with posible values `true` or `false`. type: object nullable **keyword**: 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 **serp_domain_rating_top10_min**: The keyword must have at least one ranking position in the top 10 results with a DR of up to this value. type: float nullable **serp_domain_rating_top5_min**: The keyword must have at least one ranking position in the top 5 results with a DR of up to this value. type: float nullable **serp_features**: The enriched results on a search engine results page (SERP) that are not traditional organic results. type: array(string) enum: `"ai_overview_sitelink"` `"snippet"` `"ai_overview"` `"local_pack"` `"sitelink"` `"news"` `"image"` `"video"` `"discussion"` `"tweet"` `"paid_top"` `"paid_bottom"` `"paid_sitelink"` `"shopping"` `"knowledge_card"` `"knowledge_panel"` `"question"` `"image_th"` `"video_th"` `"organic_shopping"` **serp_last_update**: The date when we last checked search engine results for a keyword. type: datetime nullable **traffic_potential** (10 units): The sum of organic traffic that the #1 ranking page for your target keyword receives from all the keywords that it ranks for. type: integer nullable **volume** (10 units): An estimation of the average monthly number of searches for a keyword over the latest known 12 months of data. type: integer nullable **volume_desktop_pct**: The percentage of searches for a keyword performed on desktop devices. type: float nullable **volume_mobile_pct**: The percentage of searches for a keyword performed on mobile devices. type: float nullable **word_count**: type: integer

[Deprecated on 31 May 2024].

The output format.

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

A two-letter country code (ISO 3166-1 alpha-2).

A manual timeout duration in seconds.

A comma-separated list of keywords to show metrics for.

A column to order results by. See response schema for valid column identifiers.

[Deprecated on 5 Aug 2024].

The id of an existing keyword list to show metrics for.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not