Отримання списку сторінок та їх позицій для домену (getUrlsSerpResultsHistory)

Метод getUrlsSerpResultsHistory повертає історію позицій та сторінки відстежуваного домену за ключовими фразами проєкту у заданому регіоні.

Загальні параметри запиту та інструкція щодо використання Serpstat API

Параметри запиту
Параметр		Значення	Опис
id	обов'язково	any number or string	Ідентифікатор запиту
method	обов'язково	RtApiSerpResultsProcedure.getUrlsSerpResultsHistory	Назва методу API
params	обов'язково	{...}	Об'єкт з параметрами
projectId	обов'язково	number	Ідентифiкатор проєкту
projectRegionId	обов'язково	number	Ідентифікатор регіону
page	обов'язково	number	Номер сторінки. За замовчуванням — 1
pageSize	опціонально	number (20, 50, 100, 200, 500)	Кількість результатів на сторінку. За замовчуванням — 100
dateFrom	опціонально	date (yyyy-mm-dd)	Дата початку періоду, за який потрібні дані
dateTo	опціонально	date (yyyy-mm-dd)	Дата кiнця періоду, за який потрібні дані
sort	опціонально	string: * date — за датою; * keyword — за алфавітом	Сортування за параметрами
order	опціонально	string: * desc — за зменшенням; * asc — за зростанням	Напрям сортування. За замовчуванням — за зменшенням.
keywords	опціонально	array: [“string”]	Ключові фрази, за якими потрібні сторінки та позиції. Максимальна кількість фраз, які можна відфільтрувати, — 1000.
domain	опціонально	string: * domain.com — домен; * https://domain.com/ — сторінка	Домен або сторінка, за якими потрібні дані. За замовчуванням — домен проєкту.

Параметри відповіді
Параметр	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
result	Містить в собі відповідь
data	Об'єкт з даними
projectId	Ідентифікатор проєкту
projectRegionId	Ідентифікатор регіону
domain	Домен або сторінка, за якими робили запит
keywords	Масив ключових фраз
keyword	Ключова фраза
history	Масив дат з видачею по ключовій фразі
date	Дата видачі
positions	Масив позицій з доменом або сторінкою
position	Позиція
url	Сторінка
positionBlock (тiльки для PPC)	Блок контекстної реклами: * top — верхній блок реклами; * sidebar — бічний блок реклами; * bottom — нижній блок реклами
summary info	Блок зведеної інформації
page	Поточна сторінка
page_total	Кількість сторінок з результатами при обраному параметрі page size
count	Кількість результатів на сторінку
total	Загальна кількість результатів
sort	Сортування за параметрами
order	Напрям сортування

За цим методом ліміти API не списуються.

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
    }
}