Get Overview Data

GET

/keyword-vault/v3.0/get-overview-data

Authentication required. Set the Authorization header to your SEOmonitor API token (raw JWT — no Bearer prefix). See the Authentication Guide for setup.

This endpoint returns the overall aggregated search, SERP, and Visibility data for all the keywords of a specified list in the Keyword Vault.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff 'https://apigw.seomonitor.com/v3/keyword-vault/v3.0/get-overview-data?campaign_id={{campaign_id}}&list={{list}}' \
--header 'Accept: application/json' \
--header 'Authorization: <api-key>'

Responses

🟢200OK

application/json

Bodyapplication/json

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

Modified at 2026-05-24 17:22:15

Get Keyword Data by List

Get Lists