Get Top 100 Results

GET

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

This endpoint returns the top 100 results for the requested keywords on a specified date.

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:

date

string

required

Example:

group_id

string

optional

The IDs of specific groups 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 identify 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 return the data. keyword_ids should be a comma-separated list of keyword IDs.

Please refer to the Quick Start Guide to learn how to identify 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:

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 default is 0, which means the API will start from the first record.

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/top-results?campaign_id={{campaign_id}}&device={{device}}&date={{date}}&group_id={{group_id}}&keyword_ids={{keyword_ids}}&limit={{limit}}&offset={{offset}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Top 100 Results

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.

top_100_results

array [object {6}]

optional

Parent field containing keyword ranking data for the competitors selected in the SEOmonitor platform, comprising of their domain, the ranking landing page for the keyword, and ranking data.

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 organic search ranking position of this specific result for the keyword on Google.

title

string

optional

The title of the search result.

description

string

optional

The description of the search result.

search_intent

string

optional

The main search intent of the landing page. Possible values are informational, commercial, and transactional.

Example

[
  {
    "keyword_id": 7882029,
    "keyword": "victoria secret",
    "top_100_results": [
      {
        "domain": "elefant.ro",
        "landing_page": "https://www.elefant.ro/list/parfumuri/filters/brand-Victoria%2527s%2BSecret",
        "rank": 1,
        "title": "Title",
        "description": "The description",
        "search_intent": "transactional"
      }
    ]
  }
]

Modified at 2024-12-13 13:06:58

Get Keywords Competition Data

Get Groups Data