Get Overview Data - SEOmonitor API 3.0

Request

Authorization

Add parameter in header

Authorization

Example:

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

Query Params

campaign_id

integer

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:

list

string

required

(Required) The name of the list created in the Keyword Vault for which you want to return keyword data.

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/keyword-vault/v3.0/get-overview-data?campaign_id={{campaign_id}}&list={{list}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

keyword_count

string

required

search_data

object

required

search_volume

string

required

year_over_year

string

required

monthly_searches

object

required

serp_data

object

required

percentage_clicks

string

required

serp_features

object

required

visibility_data

object

required

visibility

string

required

trend

string

required

Example

{
  "keyword_count": "<integer>",
  "search_data": {
    "search_volume": "<integer>",
    "year_over_year": "<double>",
    "monthly_searches": {
      "search_volume": "<integer>",
      "month": "<string>",
      "year": "<integer>"
    }
  },
  "serp_data": {
    "percentage_clicks": "<number>",
    "serp_features": {
      "feature": "<string>",
      "position": "<integer>"
    }
  },
  "visibility_data": {
    "visibility": "<double>",
    "trend": "<double>"
  }
}