Отримання історії пошукової видачі у регіоні за ключовими фразами проекту (getKeywordsSerpResultsHistory)

Метод getKeywordsSerpResultsHistory повертає топ-100 результатiв пошукової видачi Google та топ-50 Yandex у вибраному регіоні за ключовими фразами проєкту. Метод доступний тільки для органічної видачі.

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

Параметри запиту
Параметр		Значення	Опис
id	обов'язково	any number or string	Ідентифікатор запиту
method	обов'язково	RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory	Назва методу API
params	обов'язково	{...}	Об'єкт з параметрами
projectId	обов'язково	number	Ідентифікатор проєкту
projectRegionId	обов'язково	number	Ідентифiкатор регіону
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	Ключові фрази, для яких потрібні сторінки та позиції. Максимальна кількість фраз, які можна відфільтрувати, — 1000.

Параметри відповіді
Параметр	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
result	Містить в собі відповідь
data	Об'єкт з даними
projectId	Ідентифікатор проєкту
projectRegionId	Ідентифікатор регіону
keywords	Масив ключових фраз
keyword	Ключова фраза з даними
history	Масив дат з видачею по ключовій фразі
date	Дата видачі
positions	Масив позицій з доменом або сторінкою
position	Позиція
url	Сторінка
summary info	Блок зведеної інформації
page	Поточна сторінка
page_total	Кількість сторінок з результатами при обраному параметрі pageSize
count	Кількість результатів на сторінку
total	Загальна кількість результатів
sort	Сортування за параметрами
order	Напрям сортування

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

Example

Request data:

{
    "id": 1,
    "method": "RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory",
    "params": {
        "projectId": 853932,
        "projectRegionId": 293402,
        "page": 1,
        "pageSize": 500,
        "dateFrom": "2021-08-03",
        "dateTo": "2021-08-04",
        "sort": "date",
        "order": "asc",
        "keywords": ["kids soccer shirts"]
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "projectId": 853932,
            "projectRegionId": 293402,
            "keywords": [
                {
                    "keyword": "kids soccer shirts",
                    "history": [
                        {
                            "date": "2021-08-03",
                            "positions": [
                                {
                                    "position": 1,
                                    "url": "https://www.amazon.com/Best-Sellers-Sports-Outdoors-Boys-Soccer-Jerseys/zgbs/sporting-goods/2420236011"
                                },
                                {
                                    "position": 2,
                                    "url": "https://www.dickssportinggoods.com/f/youth-soccer-shirts-1"
                                },
                                {
                                    "position": 3,
                                    "url": "https://www.worldsoccershop.com/shop/products/jerseys/youth"
                                },
                                {
                                    "position": 4,
                                    "url": "https://www.etsy.com/market/kids_soccer_shirts"
                                },
                                {
                                    "position": 5,
                                    "url": "https://www.adidas.com/us/kids-soccer-jerseys"
                                },

...

                                {
                                    "position": 99,
                                    "url": "https://uniformstore.com/product-category/football-uniforms/football-uniform-sets/"
                                }
                            ]
                        },
                        {
                            "date": "2021-08-04",
                            "positions": [
                                {
                                    "position": 1,
                                    "url": "https://www.amazon.com/Best-Sellers-Sports-Outdoors-Boys-Soccer-Jerseys/zgbs/sporting-goods/2420236011"
                                },
                                {
                                    "position": 2,
                                    "url": "https://www.dickssportinggoods.com/f/youth-soccer-shirts-1"
                                },
                                {
                                    "position": 3,
                                    "url": "https://www.etsy.com/market/kids_soccer_shirts"
                                },
                                {
                                    "position": 4,
                                    "url": "https://www.worldsoccershop.com/shop/products/jerseys/youth"
                                },
                                {
                                    "position": 5,
                                    "url": "https://www.adidas.com/us/kids-soccer-jerseys"
                                },

...

                                {
                                    "position": 99,
                                    "url": "http://dcam.hansjehooghiemstra.nl/liverpool-kits.html"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "summary_info": {
            "page": 1,
            "page_total": 1,
            "count": 500,
            "total": 1,
            "sort": "date",
            "order": "asc"
        },
        "spent_limits": 0
    }
}