Get Keywords Competition Data

GET

https://apigw.seomonitor.com/v3/rank-tracker/v3.0/keywords/competition

This endpoint returns the specified competitors' ranking data for a campaign.

Request

Authorization

Add parameter in header

Authorization

Example:

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

Query Params

campaign_id

integer

required

(Required) The ID of the campaign for which keyword competitor ranking data must be returned.

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

Example:

device

string

required

(Required) The device type to get ranking data for–either desktop or mobile.

The default selection is desktop.

Example:

start_date

string

required

(Required) The start date of the date range to get ranking data for, in YYYY-MM-DD format. This is the earliest date of rankings to include.

Example:

end_date

string

required

(Required) The end date of the date range to get ranking data for, in YYYY-MM-DD format. This is the most recent date of rankings to include.

Example:

group_id

integer

optional

The ID of a specific group in the campaign to get competitor ranking data for. If not specified, returns data for all of the keywords in the campaign.

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

If you do not specify a group_id, the default value is the All Keywords group, which means data will be returned for all active keywords in the campaign.

Special Group IDs
There are several special IDs you can use to retrieve specific sets of keywords:
0: Retrieves data for all keywords.
-1: Specifies the Brand folder.
-2: Retrieves data for ungrouped keywords.
-3: Targets keywords associated with the Forecast objective

Example:

keyword_ids

string

optional

The IDs of the keywords for which you want to get competitor ranking data. keyword_ids should be a comma-separated list of keyword IDs.

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

If you do not specify keyword_ids, the API will return data for all keywords in the campaign that meet the other specified criteria (e.g. group_id).

Example:

competitors

string

optional

An optional list of competitor domain names to filter the results by. The ranking data returned will only include the specified competitors.
This parameter should be an array of strings containing one or more competitor domains, formatted as follows:
["examplecompetitor1.com", "examplecompetitor2.net"]

If you do not specify the competitors, the endpoint will return data for the competitors configured in the interface for the specified keyword group.

Example:

limit

integer

optional

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

The starting index within the results to begin returning data. 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 the parameter specified. Allowed values:

keyword

rank

rank_trend: Sorts the data based on the trend in keyword ranking.

If you do not specify the order_by parameter, the data will be sorted by default by the keyword name (keyword).

Example:

order_direction

string

optional

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

Note: The order_direction parameter works in conjunction with the order_by parameter. Use it to specify the direction of the sort after choosing the field to order by.

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

Example:

string

optional

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

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/rank-tracker/v3.0/keywords/competition?campaign_id={{campaign_id}}&device={{device}}&start_date={{start_date}}&end_date={{end_date}}&group_id={{group_id}}&keyword_ids={{keyword_ids}}&competitors={{competitors}}&limit={{limit}}&offset={{offset}}&order_by={{order_by}}&order_direction={{order_direction}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Data of the saved/required competitors, as well as data on all top competitors.

application/json

Body

keyword_id

integer

optional

The unique ID used to identify and reference the keyword in the SEOmonitor system.

keyword

string

optional

The exact keyword phrase.

competitors

array [object {4}]

optional

Parent field containing keyword ranking data for the requested competitors.

domain

string

optional

The root domain name of the competitor.

landing_page

string

optional

The full URL path of the page on the competitor's site that is currently ranking for this exact keyword.

rank

integer

optional

The current organic search ranking position of the competitor landing page for this specific keyword on Google.

rank_trend

integer

optional

The change in ranking position for the competitor's landing page for this keyword during the specified date range.

Example

{
  "keyword_id": 123456,
  "keyword_name": "buy shoes online",
  "competitors": [
    {
      "domain": "footwear.com",
      "landing_page": "https://www.footwear.com/athletic-shoes",
      "rank": 5,
      "rank_trend": 2
    },
    {
      "domain": "shoesgalore.com",
      "landing_page": "https://www.shoesgalore.com/athletic",
      "rank": 7,
      "rank_trend": -1
    },
    {
      "domain": "fancyshoes.com",
      "landing_page": "https://www.fancyshoes.com/athletic-shoes",
      "rank": 10,
      "rank_trend": 0
    },
    {
      "domain": "budgetshoes.net",
      "landing_page": "https://www.budgetshoes.net/athletic",
      "rank": 12,
      "rank_trend": 3
    },
    {
      "domain": "shoedeals.org",
      "landing_page": "https://www.shoedeals.org/athletic",
      "rank": 15,
      "rank_trend": -2
    }

Modified at 2024-12-13 13:07:09

Get Groups List

Get Top 100 Results