Get Forecast keywords
This 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
[
{
"keyword": "<string>",
"keyword_data": {
"percentage_clicks": "<double>",
"search_volume": "<integer>",
"year_over_year": "<double>",
"difficulty": "<string>"
},
"average_rank_data": {
"initial_rank": "<integer>",
"actual_rank": "<integer>",
"estimated_rank": "<integer>",
"estimated_rank_best_target": "<integer>",
"target_rank": "<integer>",
"target_rank_best": "<integer>"
},
"additional_traffic": {
"sessions": "<integer>",
"sessions_best_target": "<integer>",
"conversions": "<integer>",
"conversions_best_target": "<integer>",
"revenue": "<integer>",
"revenue_best_target": "<integer>"
}
},
{
"keyword": "<string>",
"keyword_data": {
"percentage_clicks": "<double>",
"search_volume": "<integer>",
"year_over_year": "<double>",
"difficulty": "<string>"
},
"average_rank_data": {
"initial_rank": "<integer>",
"actual_rank": "<integer>",
"estimated_rank": "<integer>",
"estimated_rank_best_target": "<integer>",
"target_rank": "<integer>",
"target_rank_best": "<integer>"
},
"additional_traffic": {
"sessions": "<integer>",
"sessions_best_target": "<integer>",
"conversions": "<integer>",
"conversions_best_target": "<integer>",
"revenue": "<integer>",
"revenue_best_target": "<integer>"
}
}
]