Get Forecast scenario Data
GEThttps://apigw.seomonitor.com/v3/forecast/v3.0/scenarioThis endpoint returns the data of Forecast Scenarios created in a specified campaign, including the scenario details, the SEO goal and configuration parameters, the forecast results overview data, and the monthly estimated results for the forecast timeframe.
Request
Query Params
campaign_id
string
required
(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.
Example:
{{campaign_id}}
forecast_id
string
required
(Required) This parameter specifies the ID of the Forecast scenario for which you want to return data.
Please refer to the Quick Start Guide to learn how to retrieve the IDs of your Forecast scenarios.
To get data for the Campaign Objective, use the 'Get Forecast Objective Data'.
Example:
183
Header Params
Accept
string
required
Example:
application/json
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
seo_goal
object
optional
keywords_count
string
required
search_data
object
required
target
object
required
goal_chance
string
required
scenario_configuration
object
optional
timeframe
string
required
start_month
string
required
extended_forecast
string
required
target_rank_range
string
required
progression_speed
string
required
use_year_over_year
string
required
use_search_volume_by_device
string
required
use_long_tail_effect
string
required
use_percentage_clicks
string
required
conversion_data
object
required
overview_data
object
optional
additional_traffic
object
required
inertial_traffic
object
required
ads_equivalent
object
required
monthly_forecast
object
optional
month
string
required
seasonality
string
required
traffic_data
object
required
monthly_forecast_extended
object
optional
month
string
required
seasonality
string
required
traffic_data
object
required
Example
{
"seo_goal": {
"keywords_count": 882,
"search_data": {
"search_volume": 8700,
"year_over_year": 1.49,
"monthly_searches": {
"month": "January",
"year": 2023,
"search_volume": 6700
},
"volume_by_device": {
"percentage_desktop": 0.84,
"percentage_mobile": 0.16
},
"percentage_clicks": 0.78
},
"target": {
"average_rank": {
"initial_rank": 18,
"trend_3months": 5,
"target_rank": 5,
"best_target_rank": 2
},
"average_visibility": {
"initial_visibility": 0.14,
"trend_3months": 0.01,
"target_visibility": 0.34,
"best_target_visibility": 0.57
}
},
"goal_chance": "realistic"
},
"scenario_configuration": {
"timeframe": "12 mo",
"start_month": "Oct 2023",
"extended_forecast": true,
"target_rank_range": false,
"progression_speed": "conservative",
"use_year_over_year": true,
"use_search_volume_by_device": true,
"use_long_tail_effect": true,
"use_percentage_clicks": true,
"conversion_data": {
"conversion_rate": 0.035,
"avg_order_value": 0.5
}
},
"overview_data": {
"additional_traffic": {
"sessions": 900,
"sessions_best_target": 90,
"conversions": 2100,
"conversions_best_target": 200,
"revenue": 78,
"revenue_best_target": 90
},
"inertial_traffic": {
"sessions": 15800000,
"conversions": 433000,
"revenue": 56000
},
"ads_equivalent": {
"equivalent": 68600,
"equivalent_best_target": 6700
}
},
"monthly_forecast": {
"month": "Oct 2023",
"seasonality": 1.83,
"traffic_data": {
"sessions": {
"inertial": 859000,
"additional": 689,
"additional_best_target": 90
},
"conversions": {
"inertial": 23500,
"additional": 500,
"additional_best_target": 80
},
"revenue": {
"inertial": 278500,
"additional": 2100,
"additional_best_target": 80
},
"visibility": {
"estimated": 0.07,
"estimated_best_target": 0
},
"estimated_avg_ranks": {
"estimated": 0.07,
"estimated_best_target": 0
}
}
},
"monthly_forecast_extended": {
"month": "Oct 2023",
"seasonality": 1.83,
"traffic_data": {
"sessions": {
"inertial": 859000,
"additional": 689,
"additional_best_target": 90
},
"conversions": {
"inertial": 23500,
"additional": 500,
"additional_best_target": 80
},
"revenue": {
"inertial": 278500,
"additional": 2100,
"additional_best_target": 80
}
}
}
}Last modified: 3 months ago