Получение списка страниц и их позиций по домену (getUrlsSerpResultsHistory)

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

Общие параметры запроса и инструкция по использованию Serpstat API

Параметры запроса
Параметр		Значение	Описание
id	обязательно	any number or string	Идентификатор запроса
method	обязательно	RtApiSerpResultsProcedure.getUrlsSerpResultsHistory	Название метода API
params	обязательно	{...}	Объект с параметрами
projectId	обязательно	number	Идентификатор проекта
projectRegionId	обязательно	number	Идентификатор региона
page	обязательно	number	Номер страницы. По умолчанию — 1
pageSize	опционально	number (20, 50, 100, 200, 500)	Количество результатов на страницу. По умолчанию — 100
dateFrom	опционально	date (yyyy-mm-dd)	Дата начала периода, по которому нужны данные
dateTo	опционально	date (yyyy-mm-dd)	Дата окончания периода, по которому нужны данные
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 (только для PPC)	Блок контекстной рекламы: * top — верхний блок рекламы; * sidebar — боковой блока рекламы; * bottom — нижний блок рекламы
summary_info	Блок сводной информации
page	Текущая страница
page_total	Количество страниц с результатами при выбранном параметре pageSize
count	Количество результатов на страницу
total	Общее количество результатов
sort	Сортировка по параметрам
order	Направление сортировки

По этому методу лимиты не списываются.

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