Get Forecast keywords
GEThttps://apigw.seomonitor.com/v3/forecast/v3.0/keywordsThis endpoint returns the forecast data for the keywords included in the Forecast Scenario or Objective, including keyword data, target rank data, and additional traffic data, for the forecast timeframe.
Request
(Required) This parameter specifies the ID of the campaign for which you want to return data.
Please refer to the Quick Start Guide to learn how to retrieve the IDs of your campaigns.
(Required) This parameter specifies the ID of the Forecast scenario set as an Objective for which you want to return data.
Please refer to the 'Quick Start Guide' to retrieve the ID of your scenarios.
This parameter determines the maximum number of records to return in a single request.
Maximum Value: 1000 records per request
If you do not specify a limit, the default number of records returned per request will be 100.
This parameter specifies the starting point within the collection of resource results. It's typically used with the limit parameter to implement pagination.
If you do not specify an offset, the API will start from the first record.
Request samples
Responses
The exact keyword phrase.
Parent field containing data for the keyword's search volume, year_over_year and percentage clicks
The percentage of searches that end up clicking on organic results for the keyword, based on the sum of Top 10 positions' CTRs after discounting the searches satisfied by SERP features.
The latest search volume of the keyword as provided by Google Ads.
The Year-over-Year search trend for the keyword, calculated as last month's search volume compared to one year ago, as provided by Google Ads.
The normalized difficulty level of the keyword - "easy", "medium", "hard". Provides an indication of how challenging it is expected to be to rank on this keyword in the top 10.
Parent field containing data for the keyword's initial, current, estimated, and target ranks.
The initial rank of the keyword for the month when the scenario was created.
The latest rank of the keyword on the day the data is returned. Returns empty if the scenario is not set as an Objective.
The estimated rank of the keyword for the month when the data is returned. If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the lower (worst) target rank.
If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the higher (best) target rank. If not enabled, this parameter will return empty.
The targetted rank of the keyword for the last month of the timeframe. If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the lower (worst) target rank.
If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the higher (best) target rank. If not enabled, this parameter will return empty.
Parent field containing data related to the estimated Additional Non-Brand Organic Traffic that would be achieved throughout the forecast timeframe if the target ranks were reached.
The total estimated Additional Sessions for the keyword throughout the forecast timeframe, including the sessions from long tail keywords if the Long Tail Effect is enabled for the Scenario or Objective. If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the lower (worst) target rank.
If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the higher (best) target rank. If not enabled, this parameter will return empty.
The total estimated Additional Conversions for the keyword throughout the forecast timeframe, including the conversions from long tail keywords if the Long Tail Effect is enabled for the Scenario or Objective. If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the lower (worst) target rank.
If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the higher (best) target rank. If not enabled, this parameter will return empty.
The estimated Additional Revenue that would be achieved throughout the forecast timeframe, including the revenue from long tail keywords if the Long Tail Effect is enabled for the Scenario or Objective. If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the lower (worst) target rank.
If the Target Rank Range parameter is enabled for the Scenario or Objective, this is the value for the higher (best) target rank. If not enabled, this parameter will return empty.
[
{
"keyword": "december birthstone",
"keyword_data": {
"percentage_clicks": 0.64,
"search_volume": 27100,
"year_over_year": 0.22,
"difficulty": "medium"
},
"average_rank_data": {
"initial_rank": 29,
"actual_rank": 21,
"estimated_rank": 23,
"estimated_rank_best_target": 0,
"target_rank": 5,
"target_rank_best": 23
},
"additional_traffic": {
"sessions": 4600,
"sessions_best_target": 0,
"conversions": 126,
"conversions_best_target": 454,
"revenue": 3400,
"revenue_best_target": 5600
}
}
]