Get Ranking Data

GET

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

This endpoint returns the SERP, search, and ranking data for the keywords specified in the request, for both your campaign website and the specified domains or URLs.

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:

keywords

array[string]

required

(Required) A comma-separated list of keyword phrases that you want to return data for.

Example:

["{{keywords}}"]

domains

string

required

(Required) A comma-separated list of domains for which you want to return the ranking data. The maximum number of domains allowed is 10.

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:

rank

rank_trend

If you do not specify an order_byparameter, the API will sort the data by rank by default.

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:

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/ranking-data?campaign_id={{campaign_id}}&keywords={{keywords}}&domains={{domains}}&limit={{limit}}&offset={{offset}}&order_by={{order_by}}&order_direction={{order_direction}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

array of:

keyword

string

optional

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

updated_on

string

optional

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

ranking_data

object

optional

Parent field containing the Google ranking data associated with the keyword for the requested domains.

domain

string

optional

The requested domain for which the ranking data is returned.

rank

integer

optional

The position on Google at the latest crawl date refreshed within the past 30 days, for desktop devices.

trend

integer

optional

The difference in positions on Google between the latest rank and the rank identified at the previous crawl, for desktop devices.

landing_page

string

optional

The landing page of your website that is currently ranking with the keyword on Google searches performed from desktop devices.

Example

[
  {
    "keyword": "go fresco",
    "updated_on": "2023-09-06",
    "ranking_data": [
      {
        "domain": "deliveroo.co.uk",
        "rank": 45,
        "trend": 3,
        "landing_page": "https://deliveroo.co.uk/restaurants/manchester/sale"
      }
    ]
  }
]

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

Get Keyword Data

Get Keyword Data by List