Get Daily Keyword Ranks

GET

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

This endpoint returns the daily desktop and mobile ranks for your website or any other domain in a specified timeframe for actively tracked or archived keywords.

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:

start_date

string

required

(Required) The start date of the timeframe for which you want to return the data, in YYYY-MM-DD format.

Example:

end_date

string

required

(Required) The end date of the timeframe for which you want to return the data, in YYYY-MM-DD format.

Example:

domain

string

optional

The domain name for which the ranks will be returned.

If no domain is provided, the endpoint will return the data for the campaign's website.

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:

keyword_ids

string

optional

The IDs of the keywords for which you want to return data. keyword_idsshould 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 that meet the other specified criteria (e.g. group_id).

Example:

get_archive

string

optional

If true, it returns data only for the archived (deleted) keywords that had been active during the requested timeframe.

The default value is false and will return the data only for actively tracked keywords.

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 API will start from the first record.

Example:

string

optional

The search parameter 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.
The search parameter is case-insensitive, allowing partial matches irrespective of casing.

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/daily-ranks?campaign_id={{campaign_id}}&start_date={{start_date}}&end_date={{end_date}}&domain={{domain}}&group_id={{group_id}}&keyword_ids={{keyword_ids}}&get_archive={{get_archive}}&limit={{limit}}&offset={{offset}}&search={{search}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Daily ranks for the keywords.

application/json

Body

keyword_id

integer

optional

The unique ID used to identify and reference the keyword in the system. It can be stored and used in other endpoints for filtering.

keyword

string

optional

The exact keyword phrase.

ranking_data

object

optional

Parent field containing the historical ranking data for the keyword including daily ranks for the requested timeframe. Provided separately for desktop and mobile.

desktop

object

optional

An array containing the daily ranking history for the keyword on desktop Google results over the requested timeframe.

mobile

object

optional

An array containing the daily ranking history for the keyword on mobile Google results over the requested timeframe.

Example

{
  "keyword_id": 355,
  "keyword": "librarie online",
  "ranking_data": {
    "desktop": [
      {
        "date": "2022-02-01",
        "rank": 4
      },
      {
        "date": "2022-02-02",
        "rank": 4
      }
    ],
    "mobile": [
      {
        "date": "2022-02-01",
        "rank": 4
      },
      {
        "date": "2022-02-02",
        "rank": 4
      }
    ]
  }
}

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

Get Groups Data

Get Daily Group Visibility