Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free..
Sign in Sign Up

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

Obtaining the list of pages and their positions by domain (getUrlsSerpResultsHistory)

The getUrlsSerpResultsHistory method returns the history of the positions and urls for the keywords to the requested region.

General request parameters and instructions for using Serpstat API

Request parameters
Pararmeter Value Description
id required any number or string Request ID
method required RtApiSerpResultsProcedure.getUrlsSerpResultsHistory API method name
params required {...} Object with parameters
projectId required number Project ID
projectRegionId required number Region ID
page required number Page number. 1  by default
pageSize optional number (20, 50, 100, 200, 500) Number of results per page. 100  by default
dateFrom optional date (yyyy-mm-dd) Start date of the period for which the data is required
dateTo optional date (yyyy-mm-dd) End date of the period for which the data is required
sort optional string:
* date  by date;
* keyword  alphabetically
Sorting by parameters
order optional string:
* desc  descending;
* asc  ascending

Sorting order. Descending order  by default

keywords optional array: [“string”] Keywords for which pages and positions are required. The maximum number of keywords that can be filtered is 1000.
domain optional string:
* domain.com  domain;
* https://domain.com/  page
Domain or page for which the data is required. By project domain  by default

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer
data
Object with data
projectId Project ID
projectRegionId Region ID
domain Domain or page for which the search results are requested
keywords Array with keywords
keyword Keyword
history Array with dates of search results by keyword
date Search results date
positions Array with positions of domain or page
position Position
url Page
positionBlock (only for PPC) PPC block:
* top — top ad block;
* sidebar — side ad block;
* bottom — bottom ad block
summary info Summary data block
page Current page
page_total Number of pages with the results for the selected parameter pageSize
count Number of results per page
total Total number of results
sort Sorting by parameters
order Sorting order

This method doesn't require API credits.

Example
Request data:
{
    "id": 1,
    "method": "RtApiSerpResultsProcedure.getUrlsSerpResultsHistory",
    "params": {
        "projectId": 853932,
        "projectRegionId": 294097,
        "page": 1,
        "pageSize": 500,
        "dateFrom": "2021-08-04",
        "dateTo": "2021-08-04",
        "sort": "date",
        "order": "asc",
        "keywords": ["adidas track", "running shoes adidas womens"],
        "domain": "https://www.adidas.com/us/running-shoes"
    }
}
Response data:
{
    "id": "1",
    "result": {
        "data": {
            "projectId": 853932,
            "projectRegionId": 294097,
            "domain": "https://www.adidas.com/us/running-shoes",
            "keywords": [
                {
                    "keyword": "adidas track",
                    "history": [
                        {
                            "date": "2021-08-04",
                            "positions": [
                                {
                                    "position": 1,
                                    "url": "https://www.adidas.com/us/running-shoes",
                                    "positionBlock": "top"
                                }
                            ]
                        }
                    ]
                },
                {
                    "keyword": "running shoes adidas womens",
                    "history": [
                        {
                            "date": "2021-08-04",
                            "positions": [
                                {
                                    "position": 1,
                                    "url": "https://www.adidas.com/us/running-shoes",
                                    "positionBlock": "top"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "summary_info": {
            "page": 1,
            "page_total": 1,
            "count": 500,
            "total": 2,
            "sort": "date",
            "order": "asc"
        },
        "spent_limits": 0
    }
}