Get Ranking Keywords

GET

https://apigw.seomonitor.com/v3/research/v3.0/domain-ranking-keywords

This endpoint returns the keywords on which the specified domain or URL ranks in top 100.
For each keyword, it will return SERP, search and two sets of ranking data for your campaign domain, and for the requested one.

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:

url

string

required

(Required) This parameter specifies the domain or URL path for which you want to return the keywords ranking in top 100.

If you request a domain, the endpoint will return the data for the entire domain.

If you request a URL, the endpoint will return the data only for the specified URL path.

Example:

limit

integer

optional

This parameter determines the maximum number of records to return in a single request.

Maximum Value: 1000 records per request

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

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:

order_by

string

optional

This parameter enables you to sort the returned data based on a specified field.

The field names you can use to sort data are:

search_volume

year-over-year

rank: Sorts the data based on the keyword rank for the requested domain or URL.

rank_trend: Sorts the data based on the trend in keyword ranking for the requested domain or URL.

my_rank: Sorts the data based on the keyword rank for the tracked website.

my_rank_trend: Sorts the data based on the trend in keyword ranking for the tracked website.

percentage_clicks: Sorts the data based on the percentage of clicks that end up on organic results after discounting the impact of the top 10 SERP features present on the keyword.

Example:

order_direction

string

optional

This parameter determines the sorting direction of the order_by field. You can sort the data in either ascending (asc) or descending (desc) order.

If you do not specify an order_direction, the default is asc.

Example:

gap_analysis

string

optional

The type of keywords you want to return data for. Allowed values are overlapping, non-overlapping, or all-keywords.

If the keyword_gap_type is not specified, data for all-keywords is returned.

Example:

string

optional

The search parameter allows you to filter the results based on a keyword name search. The API will return only those records where the keyword matches (fully or partially) the provided search term.

The search parameter is case-insensitive, allowing partial matches irrespective of casing.

Example:

porcii vietnamezi

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/domain-ranking-keywords?campaign_id={{campaign_id}}&url={{url}}&limit={{limit}}&offset={{offset}}&order_by={{order_by}}&order_direction={{order_direction}}&gap_analysis={{gap_analysis}}&search=porcii vietnamezi' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

keyword

string

optional

The exact keyword phrase for which the competitor website is ranking.

search_data

object

optional

Parent field containing the data related to Google desktop search volumes.

search_volume

integer

optional

The average 12-month desktop search volume 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 search volumes for each of the previous 13 months as provided by Google Ads.

ranking_data

object

optional

Parent field containing the Google ranking data associated with the keyword.

updated_on

string

optional

The date when the latest crawl was performed, in YYYY-MM-DD format.

my_rank

object

optional

Parent field containing the latest ranking data of the website being tracked in the SEOmonitor campaign.

competitor_rank

object

optional

Parent field containing the latest ranking data of the requested domain or URL.

serp_data

object

optional

Parent field containing the SERP features data on desktop search results for the keyword recorded on the latest crawl date refreshed within the past 30 days. 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

object

optional

Parent field containing the data for the SERP features present for the keyword on the latest crawl date.

tracked_keyword_id

integer

optional

The unique ID used to identify and reference the keyword in the system. Returned only if the keyword is tracked in the SEOmonitor campaign. It can be stored and used in other endpoints for filtering.

Example

[
  {
    "keyword": "go fresco",
    "search_data": {
      "search_volume": 887,
      "year_over_year": 1.45,
      "monthly_searches": [
        {
          "month": "June",
          "year": 2023,
          "search_volume": 889
        }
      ]
    },
    "ranking_data": {
      "updated_on": "2023-09-06",
      "my_rank": {
        "rank": 45,
        "trend": 3,
        "landing_page": "https://deliveroo.co.uk/restaurants/manchester/sale"
      },
      "competitor_rank": {
        "rank": 28,
        "trend": -1,
        "landing_page": "https://www.ubereats.com/gb/category/leicester-eng/dessert"
      }
    },
    "serp_data": {
      "percentage_clicks": 0.77,
      "serp_features": [
        {
          "feature": "IMG",
          "position": 4
        }
      ]
    },
    "tracked_keyword_id": 1789784
  }
]

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

Get URL/Domain Overview

Get Keyword Data