Get Forecast scenarios - SEOmonitor API 3.0

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:

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

curl --location -g --request GET 'https://apigw.seomonitor.com/v3/forecast/v3.0/scenarios?campaign_id={{campaign_id}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

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.

Example

{
  "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"
}