Get Tracked Campaigns - SEOmonitor API 3.0

This endpoint returns a list of active Tracked Campaigns with their details, such as campaign_id, name, URL, keyword number, date created, account manager details, and Visibility data.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

campaign_ids

string

optional

The Tracked Campaigns IDs for which you want the data to be returned.

Please refer to the Quick Start Guide to learn how to retrieve your campaign IDs.

If you do not specify campaign_ids, the endpoint will return the data for all active Tracked Campaigns you have access to, across all company accounts.

Example:

company_id

integer

optional

The ID of the subscription that contains the Tracked Campaigns for which you want to return data. This is useful for users who have access to multiple company accounts.

Please refer to the Quick Start Guide to learn how to retrieve your company IDs.

If you don't specify a company_id, the endpoint will return the data for all Tracked Campaigns you have access to, across all company accounts.

Example:

limit

integer

optional

The maximum number of Tracked Campaigns to return data for.

Maximum Value: 100 records per request

If you do not specify a limit, the default number of records returned per request will be 10.

Example:

offset

integer

optional

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.

Example:

Header Params

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

array of:

campaign_info

object

required

string

required

name

string

required

company

string

required

company_id

string

required

date_created

string

required

keywords_count

string

required

campaign_currency

string

required

analytics_currency

string

required

domain

string

required

location

string

required

mrr

string

required

visibility

object

required

desktop

object

required

mobile

object

required

multiple_locations

array[string]

required

health_status

string

required

objective_status

object

required

status

string

required

actual_sessions

string

required

estimated_sessions

string

required

performance

number

required

start_month

string

required

end_month

string

required

reporting_status

string

required

account_manager

string

required

Example

[
  {
    "campaign_info": {
      "id": 102933,
      "name": "seomonitor.com",
      "company": "SEOmonitor",
      "company_id": 20077,
      "domain": "https://seomonitor.com",
      "keywords_number": 703,
      "date_created": "2021-12-17",
      "location": "United Kingdom",
      "campaign_currency": "RON",
      "analytics_currency": "EUR",
      "mrr": 2300
    },
    "visibility": {
      "desktop": {
        "latest": 53.3,
        "trend_7days": -0.5,
        "trend_30days": 1.2
      },
      "mobile": {
        "latest": 52.3,
        "trend_7days": -0.7,
        "trend_30days": 1.3
      }
    },
    "objective": {
      "actual_sessions": 10,
      "estimated_sessions": 10,
      "performance": 1,
      "status": "on_track",
      "start_month": "Nov, 2023",
      "end_month": "Nov, 2024"
    },
    "health_status": "average",
    "reporting_status": "pending",
    "account_manager": "Jon Seo",
    "multiple_locations_campaigns": [
      {
        "id": 102933,
        "name": "seomonitor.com",
        "keywords_number": 703,
        "date_created": "2021-12-17",
        "location": "United Kingdom",
        "visibility": {
          "desktop": {
            "latest": 53.3,
            "trend_7days": -0.5,
            "trend_30days": 1.2
          },
          "mobile": {
            "latest": 52.3,
            "trend_7days": -0.7,
            "trend_30days": 1.3
          }
        }
      }
    ]
  }
]