SEOmonitor API 3.0

Get Forecast scenarios

GEThttps://apigw.seomonitor.com/v3/forecast/v3.0/scenarios

This endpoint returns a list of Scenarios created in a specified campaign, including the Objective if one is set, and their details.

Request

Authorization: API Key

Add parameter in header

Authorization

Example

Authorization: 2f68dbbf-519d-4f01-9636-e2421b68f379

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:

Header Params

string

required

Example:

application/json

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

forecast_id

integer

optional

The ID of the Forecast scenario for which the data is returned.

name

string

optional

The name assigned to the scenario in the platform.

objective

string

optional

Whether the Forecast scenario is set as the current Objective of the campaign.

created_date

string

optional

The date when the scenario was created, in YYYY-MM-DD format.

created_by

string

optional

The first and last name of the user who created the scenario.

updated_date

string

optional

The date when the last changes were made to the SEO goal and configuration of the scenario.

monthly_budget

integer

optional

The monthly budget allocated to the scenario, in the campaign currency.

{
  "forecast_id": 2282,
  "name": "Furniture forecast",
  "objective": false,
  "created_date": "2023-08-01",
  "created_by": "Andrea Jones",
  "update_date": "2023-08-27",
  "monthly_budget": "5600"
}

Last modified: 16 days ago