Пошукові підказки за ключовою фразою V4 (SerpstatKeywordProcedure.getSuggestions)

Метод SerpstatKeywordProcedure.getSuggestions виконує повнотекстовий пошук по пошуковим підказкам аналізованого ключового слова. Аналогічний до звіту Аналіз ключових слів — SEO-аналіз — Пошук підказок.

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

Доступні пошукові бази

Параметри запиту
Назва	Опис	Тип даних	Опціональний	Значение за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. Допускається введення будь-якого числового (number) або текстового (string) значення	int/string	ні		1, test
method	Назва методу API	string	ні		SerpstatKeywordProcedure.getSuggestions
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]	array	ні
keyword	Фраза, для якої буде відбуватися пошук	string	ні		iphone
se	Ідентифікатор пошукової бази, по якій буде проходити пошук (доступні бази Google і Yandex на вибір, наприклад: g_us, y_157).	string	ні		g_us
page	Номер сторінки у відповіді	int	так	1	"page": "5"
size	Кількість результатів на сторінку у відповіді	int	так	100	"size": "10" min: 1, max: 1000

Параметри відповіді
Параметр	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
result	Містить в собі відповідь
data	Масив з даними
keyword	Задана ключова фраза
geo_names	Список топонімів в масиві, якщо топонім присутній в ключовій фразі. Якщо немає - масив порожній.
summary_info	Об'єкт з даними відповіді
page	Номер сторінки
total	Кількість знайдених пошукових підказок
left_lines	Кількість API рядків, що залишилися

Частина відповіді API, за яку знімається 1 ліміт:

{
    "keyword": "iphone x fre case release",
    "geo_names": []
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatKeywordProcedure.getSuggestions",
 "params": {
   "keyword": "iphone",
   "se": "g_us",
   "page": "1",
   "size": "10"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "keyword": "iphone x fre case release",
                "geo_names": []
            },
            {
                "keyword": "iphone 7 plus tekniset tiedot",
                "geo_names": []
            },
            {
                "keyword": "softlogic iphone x",
                "geo_names": []
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 2652668,
            "left_lines": 998721
        }
    }
}