Get Ranking Pages

GET

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

This endpoint returns the ranking pages of the tracked keywords in a campaign.
The response contains an array with ranking pages and their URL, title, description, and associated keyword IDs.

Note: Using the keyword IDs of the ranking keywords for the returned landing pages, you can make API calls through the other endpoints, in order to further process landing page-level search volumes, Visibility, and other metrics.

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:

group_id

string

optional

The IDs of specific groups in the campaign to get keyword data for.

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:

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

Example:

string

optional

The search parameter allows you to filter for landing pages that include the searched term or URL path.
The API will return only those records where the landing page matches (fully or partially) the provided search term or URL.

Example:

https://www.elefant.ro/enigma-otiliei_937f1c4a-dbe9-498e-b983-fdd6ffad83a0

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/ranking-pages?campaign_id={{campaign_id}}&group_id={{group_id}}&limit={{limit}}&offset={{offset}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

array of:

url

string

optional

The specific page on your website for which rankings and keywords are returned.

title

string

optional

The title tag content of the search result page.

description

string

optional

The meta description content of the search result page.

ranking_keywords

array [object {2}]

optional

Parent field containing the list of keywords the landing page URL is currently ranking for, and their IDs. You can use these returned keyword_ids to make API calls through the other endpoints, in order to further process landing page-level search volumes, Visibility, and other metrics.

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.

Example

[
  {
    "url": "[https://www.myshoestore.com/athletic-shoes",
    "title": "Athletic Shoes for Men and Women",
    "description": "Find the perfect athletic shoes for your sport or activity. Free shipping and returns. Top brands for running, walking, cross-training and more.",
    "ranking_keywords": [
      {
        "keyword_id": 123,
        "keyword": "Athletic Shoes"
      }
    ]
  }
]

Modified at 2024-12-13 13:08:13

Get Daily SERP Feature Presence

Get Daily Share of Clicks