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

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

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

Параметры запроса
Параметр	Описание	Тип	Обязательный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор.	int / string	да		Любое текстовое или числовое значение. Например: 1, test, тест
method	Название метода API	string	да		RtApiSerpResultsProcedure.getUrlsSerpResultsHistory
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]		да
projectId	Идентификатор проекта	int	да		Числовое значение идентификатора проекта
projectRegionId	Идентификатор региона	int	да		Числовое значение идентификатора региона
page	Номер страницы	int	да	1	Числовое значение.
pageSize	Количество результатов на странице	int	нет	100	Числовое значение. Возможные варианты значений: 20, 50, 100, 200, 500
dateFrom	Дата начала периода, по которому нужны данные	date	нет	Все даты снятия позиций	Числовое значение, формат данных: yyyy-mm-dd
dateTo	Дата конца периода, по которому нужны данные	date	нет	Все даты снятия позиций	Числовое значение, формат данных: yyyy-mm-dd
sort	Сортировка по параметрам	string	нет	alphabetically	"date" — Сортировка по дате, "keyword" — Сортировка по алфавиту
order	Направление сортировки	string	нет	desc	desc — по убыванию, asc — по возрастанию
keywords	Ключевые фразы, по которым нужны страницы и позиции	array	нет	Все ключевые фразы проекта	Текстовое значение. Максимальное количество фраз, которые можно отфильтровать — 1000.
domain	Домен или страница, по которым нужны данные	string	нет	project domain	Текстовое значение. Формат данных: domain.com — домен, https://domain.com/ — страница
withTags	Отображение тегов ключевых фраз	string	нет	false	Текстовое значение. "true" или "false"

Параметры ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Содержит в себе ответ
data	Объект с данными
projectId	Идентификатор проекта
projectRegionId	Идентификатор региона
domain	Домен или страница, по которой запрашивали результат
keywords	Массив ключевых фраз
keyword	Ключевая фраза
frequency	Частотность ключевого слова за месяц в выбранной стране или городе
expectedUrl	Целевая страница, которая оптимизируется под конкретную фразу (если она была добавлена в проекте)
tags	Массив идентификаторов тегов и их значений (названия тегов)
history	Массив дат с выдачами по ключевой фразе
date	Дата выдачи
positions	Массив позиций с доменом или страницей
position	Позиция
url	Страница, которая показывается в результатах поиска по определенной фразе.
positionBlock (только для PPC)	Блок контекстной рекламы: * top — верхний блок рекламы; * sidebar — боковой блока рекламы; * bottom — нижний блок рекламы
summary_info	Блок сводной информации
page	Текущая страница
page_total	Количество страниц с результатами при выбранном параметре pageSize
count	Количество результатов на страницу
total	Общее количество результатов
sort	Сортировка по параметрам
order	Направление сортировки

Возможные ошибки в ответе
Код ошибки	Описание
-32009\-32602	Невалидные параметры запроса. Описание какие параметры и в чем проблема
-33054	Проект удален
-34001	Неправильный projectRegionId для проекта
-34002	Диапазон дат должен содержать менее 30 дат анализа
-34003	Ключевые фразы не найдены в проекте
-32002	Пустой результат

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

Example

Request data:

{
    "id": 1,
    "method": "RtApiSerpResultsProcedure.getUrlsSerpResultsHistory",
    "params": {
        "projectId": 930722,
        "projectRegionId": 309245,
        "page": 1,
        "pageSize": 500,
        "dateFrom": "2023-10-09",
        "dateTo": "2023-10-23",
        "sort": "date",
        "order": "desc",
        "keywords": [],

        "withTags": false,
        "domain": "https://makeup.com.ua/brand/29737/"
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "projectId": 930722,
            "projectRegionId": 309245,
            "domain": "https://makeup.com.ua/brand/29737/",
            "keywords": [
                {
                    "keyword": "фрэнчи",
                    "frequency": 27100,
                    "expectedUrl": "https://makeup.com.ua/",
                    "history": [
                        {
                            "date": "2023-10-23",
                            "positions": [
                                {
                                    "position": 1,
                                    "url": "https://makeup.com.ua/brand/29737/"
                                }
                            ]
                        },
                        {
                            "date": "2023-10-16",
                            "positions": [
                                {
                                    "position": 2,
                                    "url": "https://makeup.com.ua/brand/29737/"
                                }
                            ]
                        },
                        {
                            "date": "2023-10-09",
                            "positions": [
                                {
                                    "position": 2,
                                    "url": "https://makeup.com.ua/brand/29737/"
                                }
                            ]
                        }
                    ]
                },
                {
                    "keyword": "френчи",
                    "frequency": 27100,
                    "expectedUrl": "",
                    "history": [
                        {
                            "date": "2023-10-23",
                            "positions": []
                        },
                        {
                            "date": "2023-10-16",
                            "positions": [
                                {
                                    "position": 2,
                                    "url": "https://makeup.com.ua/brand/29737/"
                                }
                            ]
                        },
                        {
                            "date": "2023-10-09",
                            "positions": [
                                {
                                    "position": 2,
                                    "url": "https://makeup.com.ua/brand/29737/"
                                }
                            ]
                        }
                    ]
                },
                {
                    "keyword": "главкома",
                    "frequency": 165000,
                    "expectedUrl": "",
                    "history": [
                        {
                            "date": "2023-10-23",
                            "positions": []
                        },
                        {
                            "date": "2023-10-16",
                            "positions": []
                        },
                        {
                            "date": "2023-10-09",
                            "positions": []
                        }
                    ]
                },
                {
                    "keyword": "мейкап украина",
                    "frequency": 0,
                    "expectedUrl": "https://www.americanhorror.fans/",
                    "history": [
                        {
                            "date": "2023-10-23",
                            "positions": []
                        },
                        {
                            "date": "2023-10-16",
                            "positions": []
                        },
                        {
                            "date": "2023-10-09",
                            "positions": []
                        }
                    ]
                },
                {
                    "keyword": "косметика для всей семьи и не только покупайте и радуйтесь",
                    "frequency": 0,
                    "expectedUrl": "",
                    "history": [
                        {
                            "date": "2023-10-23",
                            "positions": []
                        },
                        {
                            "date": "2023-10-16",
                            "positions": []
                        },
                        {
                            "date": "2023-10-09",
                            "positions": []
                        }
                    ]
                },
        "summary_info": {
            "page": 1,
            "page_total": 1,
            "count": 500,
            "total": 44,
            "sort": "date",
            "order": "desc"
        },
        "spent_limits": 0
    }
}