Get Topic Overview

GET

https://apigw.seomonitor.com/v3/research/v3.0/topic-overview

This endpoint returns the overall aggregated search, SERP, and your website's Visibility data for all the related keywords of a specified keyword (topic).

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:

keyword

string

required

(Required) The topic for which you want to return related keywords' data.

Example:

Header Params

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200Success

application/json

Body

related_keywords

integer

optional

The total number of curated keywords returned for the specified topic.

search_data

object

optional

Parent field containing the data related to Google search volumes for the keywords returned.

search_volume

integer

optional

The average 12-month search volume of all the keywords returned, as provided by Google Ads.

year_over_year

number

optional

A numeric value representing the last month's search volume divided by the search volume of the same month of the previous year. E.g. +49% year-over-year search trend would be represented as 1.49. The returned values will be capped at 10, which represents "newcomers" (keywords that registered very low search volumes in the previous year).

monthly_searches

object

optional

An array of objects containing the aggregated search volumes for each of the previous 13 months as provided by Google Ads.

serp_data

object

optional

Parent field containing the top 10 SERP features present for the keywords in the returned list and their presence count for the day of the latest crawl refreshed within the past 30 days, for desktop searches. Please refer to the Quick Start Guide for the complete feature name of each abbreviation.

percentage_clicks

number

optional

The percentage of searches that end up clicking on organic results, based on the sum of Top 10 positions' CTRs after discounting the searches satisfied by SERP features.

serp_features

array [object {2}]

optional

Parent field containing the top 10 SERP features present for the returned keywords and their presence count for the day of the latest crawl refreshed within the past 30 days, for desktop searches. Please refer to the Quick Start Guide for the complete feature name of each abbreviation.

visibility_data

object

optional

Parent field containing the Visibility metrics and trends for the campaign website and the requested domain or URL. Note: If the request was made for the 'non-overlapping' keyword gap type, the returned values will be '0'.

visibility

number

optional

The desktop Visibility of your website on the day of the latest crawl which is refreshed within the past 30 days.

trend

number

optional

The percentage increase or decrease in your desktop Visibility over the past two crawl dates.

Example

{
  "related_keywords": 495,
  "search_data": {
    "search_volume": 887,
    "year_over_year": 1.45,
    "monthly_searches": [
      {
        "month": "June",
        "year": 2023,
        "search_volume": 889
      }
    ]
  },
  "serp_data": {
    "percentage_clicks": 0.7,
    "serp_features": [
      {
        "feature": "IMG",
        "count": 10
      }
    ]
  },
  "visibility_data": {
    "visibility": 0.19,
    "trend": -0.2
  }
}

Modified at 2024-11-05 13:59:03

Get Related Keywords

Get URL/Domain Overview