GET /organic-keywords
Servers
- https://api.ahrefs.com/v3/site-explorer
Query parameters
Name | Type | Required | Description |
---|---|---|---|
where |
String | No |
The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the best_position: The top position your target ranks for in the organic search results for a keyword. best_position_diff: The change in position between your selected dates. best_position_has_thumbnail: The top position has a thumbnail. best_position_has_thumbnail_prev: The top position has a thumbnail on the comparison date. best_position_has_video: The top position has a video. best_position_has_video_prev: The top position has a video on the comparison date. best_position_kind: The kind of the top position: organic, paid, or a SERP feature. best_position_kind_merged: The kind of the top position optimized for sorting. best_position_kind_prev: The kind of the top position on the comparison date. best_position_prev: The top position on the comparison date. best_position_set: The ranking group of the top position. best_position_set_prev: The ranking group of the top position on the comparison date. best_position_url: The ranking URL in organic search results. best_position_url_prev: The ranking URL on the comparison date. best_position_url_raw: The ranking page URL in encoded format. best_position_url_raw_prev: The ranking page URL on the comparison date in encoded format. cpc: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in cents. cpc_merged: The CPC field optimized for sorting. cpc_prev: The CPC metric on the comparison date. is_best_position_set_top_11_50: The ranking group of the top position is 11-50. is_best_position_set_top_11_50_prev: The ranking group of the top position was 11-50 on the comparison date. is_best_position_set_top_3: The ranking group of the top position is Top 3. is_best_position_set_top_3_prev: The ranking group of the top position was Top 3 on the comparison date. is_best_position_set_top_4_10: The ranking group of the top position is 4-10. is_best_position_set_top_4_10_prev: The ranking group of the top position was 4-10 on the comparison date. is_main_position: Excludes positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter). is_main_position_prev: Excludes positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter) on the comparison date. keyword: The keyword your target ranks for. 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. keyword_difficulty_merged (10 units): The keyword difficulty field optimized for sorting. keyword_difficulty_prev (10 units): The keyword difficulty on the comparison date. keyword_merged: The keyword field optimized for sorting. keyword_prev: The keyword your target ranks for on the comparison date. language: The SERP language. language_prev: The SERP language on the comparison date. last_update: The date when we last checked search engine results for a keyword. last_update_prev: The date when we checked search engine results up to the comparison date. 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. position_kind_prev: The kind of a position on the comparison date. serp_features: The SERP features that appear in search results for a keyword. serp_features_count: The number of SERP features that appear in search results for a keyword. serp_features_count_prev: The number of SERP features on the comparison date. serp_features_merged: The SERP features field optimized for sorting. serp_features_prev: The SERP features on the comparison date. 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). 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. serp_target_positions_count: The number of target URLs ranking for a keyword. serp_target_positions_count_prev: The number of target URLs ranking for a keyword on the comparison date. 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"). sum_paid_traffic (10 units): An estimation of the number of monthly visits that your target gets from paid search for a keyword. sum_traffic (10 units): An estimation of the number of monthly visitors that your target gets from organic search for a keyword. sum_traffic_merged (10 units): The traffic field optimized for sorting. sum_traffic_prev (10 units): The traffic on the comparison date. title: The title displayed for the page in a keyword's SERP. title_prev: The title displayed for the page in a keyword's SERP on the comparison date. volume (10 units): An estimation of the number of searches for a keyword over the latest month. volume_merged (10 units): The search volume field optimized for sorting. volume_prev (10 units): The search volume on the comparison date. words: The number of words in a keyword. words_merged: The number of words in a keyword optimized for sorting. words_prev: The number of words in a keyword on the comparison date. |
volume_mode |
String | No |
The search volume calculation mode: monthly or average. It affects volume, traffic, and traffic value. Possible values:
Default value: "monthly" |
protocol |
String | No |
The protocol of your target. Possible values:
Default value: "both" |
output |
String | No |
The output format. Possible values:
|
mode |
String | No |
The scope of the search based on the target you entered. Possible values:
Default value: "subdomains" |
date |
String | Yes |
A date to report metrics on in YYYY-MM-DD format. |
select |
String | Yes |
A comma-separated list of columns to return. See response schema for valid column identifiers. |
order_by |
String | No |
A column to order results by. See response schema for valid column identifiers. |
limit |
Integer | No |
The number of results to return. |
target |
String | Yes |
The target of the search: a domain or a URL. |
timeout |
Integer | No |
A manual timeout duration in seconds. |
date_compared |
String | No |
A date to compare metrics with in YYYY-MM-DD format. |
country |
String | Yes |
A two-letter country code (ISO 3166-1 alpha-2). Possible values:
|
offset |
Integer | No |
[Deprecates on 31 May 2024] Returned results will start from the row indicated in the offset value. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.