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

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

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

Параметри запиту
Параметр	Опис	Тип	Опціональний	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор	int/string	ні		Будь-яке числове або текстове значення. Наприклад: 1, test, хаймарс
method	Назва методу API	string	ні		RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]		ні
projectId	Ідентифікатор проєкту	number	ні		Числове значення ідентифікатору проєкту
projectRegionId	Ідентифiкатор регіону	number	ні		Числове значення ідентифікатору регіону
page	Номер сторінки	number	ні	1	Числове значення
pageSize	Кількість результатів на сторінку	number	так	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/ — сторінка

Параметри відповіді
Параметр	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
result	Містить в собі відповідь
data	Об'єкт з даними
projectId	Ідентифікатор проєкту
projectRegionId	Ідентифікатор регіону
domain	Домен або сторінка, за якими робили запит
keywords	Масив ключових фраз
keyword	Ключова фраза
frequency	Частотність ключової фрази за місяць в обраній країні чи місті
expectedUrl	Цільова сторінка, яка оптимізується під конкретну фразу (якщо вона була додана у проєкті)
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": 293402,
        "page": 1,
        "pageSize": 500,
        "dateFrom": "2021-12-12",
        "dateTo": "2021-12-12",
        "sort": "date",
        "order": "desc",
        "keywords": ["adidas track", "running shoe adidas"],
        "domain": "adidas.com"
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "projectId": 853932,
            "projectRegionId": 293402,
            "domain": "adidas.com",
            "keywords": [
                {
                    "keyword": "running shoe adidas",
                    "frequency": 49500,
                    "expectedUrl": "https://www.adidas.com/us/ultraboost",
                    "history": [
                        {
                            "date": "2021-12-12",
                            "positions": [
                                {
                                    "position": 1,
                                    "url": "https://www.adidas.com/us/men-running-shoes"
                                }
                            ]
                        }
                    ]
                },
                {
                    "keyword": "adidas track",
                    "frequency": 49500,
                    "expectedUrl": "https://www.adidas.com/us/track",
                    "history": [
                        {
                            "date": "2021-12-12",
                            "positions": [
                                {
                                    "position": 1,
                                    "url": "https://www.adidas.com/us/track"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "summary_info": {
            "page": 1,
            "page_total": 1,
            "count": 500,
            "total": 2,
            "sort": "date",
            "order": "desc"
        },
        "spent_limits": 0
    }
}