SEOmonitor API 3.0
  1. Forecast
SEOmonitor API 3.0
  • Overview
  • Campaigns
    • Get Tracked Campaigns
      GET
  • Rank Tracker
    • Get Keyword Data
      GET
    • Get Keyword AI Overview Data
      GET
    • Get Groups List
      GET
    • Get Keywords Competition Data
      GET
    • Get Top 100 Results
      GET
    • Get Groups Data
      GET
    • Get Daily Keyword Ranks
      GET
    • Get Daily Group Visibility
      GET
    • Add New Keywords
      POST
    • Get Keywords Import Status
      GET
    • Get Daily SERP Feature Presence
      GET
    • Get Ranking Pages
      GET
    • Get Daily Share of Clicks
      GET
  • Organic Traffic
    • Get Daily Traffic Data by Segment
      GET
    • Get Traffic Data by Keywords
      GET
  • Research
    • Keyword Research
      • By Topic
        • Get Related Keywords
        • Get Topic Overview
      • By URL/Domain
        • Get URL/Domain Overview
        • Get Ranking Keywords
      • Get Keyword Data
      • Get Ranking Data
    • Keyword Vault
      • Get Keyword Data by List
      • Get Overview Data
  • Forecast
    • Get Forecast scenarios
      GET
    • Get Forecast scenario Data
      GET
    • Get Forecast objective Data
      GET
    • Get Forecast keywords
      GET
  1. Forecast

Get Forecast objective Data

GET
https://apigw.seomonitor.com/v3/forecast/v3.0/objective
This endpoint returns the data of Forecast Scenarios set as Objectives, including the SEO goal and configuration parameters, the forecast results overview data, and the monthly actual and estimated results for the forecast timeframe.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
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.
Example:
231
Header Params
Accept
string 
required
Example:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://apigw.seomonitor.com/v3/forecast/v3.0/objective?campaign_id={{campaign_id}}&forecast_id=231' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body
objective_data
object 
optional
Parent field containing the Objective completion date, and the completion status.
completion_date
string 
optional
The month and year when the Objective has been or will be completed.
completion_status
object 
optional
Parent field containing data related to the Objective completion status for the last 30 days and from the start of the forecast to the current date.
seo_goal
object 
optional
Parent field containing data for the SEO goal parameters. In the platform, these parameters are defined in the scenario setup through the wizard or in the scenario sidebar.
keywords_count
integer 
optional
The total number of keywords included in the Objective.
search_data
object 
optional
Parent field containing the data related to the average Google search volumes of the keywords included in the Objective.
target
object 
optional
Parent field containing the SEO target data for the keywords included in the Objective.
goal_chance
string 
optional
The chance of achieving the target ranks considering the average Difficulty of the keywords weighted by Additional Sessions, the average Target Rank and the Initial Rank, and the configured Progression Speed. Possible values are 'realistic', 'ambitious', or 'too ambitious'.
scenario_configuration
object 
optional
Parent field containing data related to the parameters configured for the forecast algorithm.
timeframe
string 
optional
The duration of the scenario in months.
start_month
string 
optional
The month and year when the scenario was set to start.
extended_forecast
boolean 
optional
Whether the projection includes the extended forecast timeframe and the results estimated for it.
target_rank_range
boolean 
optional
Whether the target rank range option is enabled for the Objective. If 'true', the estimated results of the forecast will be returned for both the lower (worst) and the higher (best) target.
progression_speed
string 
optional
The user-configured speed at which the average selected target rank will be reached. Possible values are 'conservative', 'mostly conservative', 'moderate', 'mostly moderate', 'optimistic', 'mostly optimistic', and 'custom'.
use_year_over_year
boolean 
optional
Whether the option to include the Year-over-Year search trends of the keywords in the forecast calculation is enabled.
use_search_volume_by_device
boolean 
optional
Whether the option to include the search volume for each device of the keywords in the forecast calculation is enabled.
use_long_tail_effect
boolean 
optional
Whether the option to include the estimation of additional traffic generated by other keywords semantically related to the ones included in the forecast is enabled.
use_percentage_clicks
boolean 
optional
Whether the option to include the Percentage Clicks metric in the forecast calculation is enabled.
conversion_data
object 
optional
Parent field containing data related to the Conversion Rate and the Average Order Value that are used to calculate the Additional Conversions and Additional Revenue estimated to be obtained throughout the Forecast.
overview_data
object 
optional
Parent field containing the estimated Additional Non-Brand Organic Traffic that would be achieved throughout the forecast timeframe.
additional_traffic
object 
optional
Parent field containing the estimated Additional Non-Brand Organic Traffic that would be achieved throughout the forecast timeframe.
inertial_traffic
object 
optional
Parent field containing the estimated Inertial Non-Brand Organic Traffic that would be achieved throughout the forecast timeframe if the ranks remained the same as the current ranks.
ads_equivalent
object 
optional
Parent field containing the Ads Equivalent budget.
monthly_forecast
object 
optional
Parent field containing the forecast data for each month of the timeframe, including traffic, Visibility, average ranks, and search seasonality.
month
string 
optional
The month and year in the forecast timeframe for which data is returned.
seasonality
number 
optional
The average search seasonality of the keywords included in the forecast scenario for the specific month of the timeframe. The value is returned as a percentage related to the 12-month seasonality average, where 1.00 represents the average value.
traffic_data
object 
optional
Parent field containing the data for the non-brand organic sessions, conversions, and revenue for the specific month of the timeframe.
monthly_forecast_extended
object 
optional
Parent field containing the forecast data for each month of the following equal timeframe (extended forecast), including traffic data and search seasonality.
month
string 
optional
The month and year in the forecast timeframe for which data is returned.
seasonality
number 
optional
The average search seasonality of the keywords included in the forecast scenario for the specific month of the timeframe. The value is returned as a percentage related to the 12-month seasonality average, where 1.00 represents the average value.
traffic_data
object 
optional
Parent field containing the data for the non-brand organic sessions, conversions, and revenue for the specific month of the timeframe.
Example
{ 
    "objective_data": {
        "completion_date": "Oct 2025",
        "completion_status": {
            "30days": {
                "actual_sessions": 89500,
                "forecasted_sessions": 89500
            },
            "start_to_date": {
                "actual_sessions": 610000,
                "forecasted_sessions": 600000
            }
        }
    },
    "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": 057
            }
        },
        "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": {
                "actual": 859000,
                "additional": 689,
                "additional_best_target": 90
            },
            "conversions": {
                "actual": 23500,
                "additional": 500,
                "additional_best_target": 80
            }, 
            "revenue": {
                "actual": 278500,
                "additional": 2100,
                "additional_best_target": 80
            }
        }
    }
}
Modified at 2024-11-05 14:00:28
Previous
Get Forecast scenario Data
Next
Get Forecast keywords
Built with