Схожі ключові фрази V4 (SerpstatKeywordProcedure.getRelatedKeywords)

Метод SerpstatKeywordProcedure.getRelatedKeywords повертає пошукові запити, які пов'язані з аналізованою ключовою фразою семантично. Аналогічний до звіту Аналіз ключових слів — SEO-аналіз — Схожі фрази.

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

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

Параметри запиту
Параметр	Опис	Тип даних	Опціональний	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. Допускається введення будь-якого числового (number) або текстового (string) значення	int/string	ні		1, test
method	Назва методу API	string	ні		SerpstatKeywordProcedure.getRelatedKeywords
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]	array	ні
keyword	Фраза, для якої буде відбуватися пошук	string	ні		iphone
se	Ідентифікатор пошукової бази, по якій буде проходити пошук (доступні бази Google і Yandex на вибір, наприклад: g_us, y_157).	string	ні		g_us
filters	Умови фільтраціі	array	так		Сила зв'язку схожих фраз {"Weight": {{weight_from}} {"right_spelling": true}
sort	Порядок сортування результатів в форматі: {{{Field}}: {{order}}} field — поле, за яким потрібно виконати сортування: * cost * concurrency * weight * region_queries_count * keyword order — напрямок сортування (asc — за зростанням, desc — за спаданням)	array	так		{ cost: {{"asc"\|"desc"}}}
page	Номер сторінки у відповіді	int	так	1	"page": "5"
size	Кількість результатів на сторінку у відповіді	int	так	100	"size": "10" min: 1, max: 1000

Параметри відповіді
Параметр	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
result	Містить в собі відповідь
data	Масив з даними
keyword	Задана ключова фраза
region_queries_count	Частотність ключової фрази в обраному регіоні
cost	Ціна за клік, $
concurrency	Конкуренція ключевої фрази в PPC (0-100%)
geo_names	Список топонімів в масиві, якщо топонім присутній в ключовій фразі. Якщо немає - масив порожній.
types	Список додаткових елементів які відображаються в SERP (наприклад, відео, карусель зображень, карта та інше).
right_spelling	Рекомендація до виправлення для ключової фрази з орфографічною помилкою
weight	Сила зв'язку схожих фраз
difficulty	Оцінка рівня конкуренції за ключовою фразою для просування в топ-10 (від 0 до 100%)
summary_info	Об'єкт з даними відповіді
page	Номер сторінки
total	Кількість знайдених схожих фраз
left_lines	Кількість API рядків, що залишилися

Ліміти: кількість списаних лімітів відповідає кількості отриманих результатів за запитом. За один запит можна отримати не більше 60000 результатів. Частина відповіді API, за яку знімається 1 ліміт:

"11 pro price iphone": {
    "keyword": "11 pro price iphone",
    "region_queries_count": 70,
    "cost": 0,
    "concurrency": 0,
    "geo_names": [],
    "types": [
        "related_search",
        "top_stories",
        "shopping_top",
        "also_asks",
        "kn_graph_carousel_list",
        "snip_breadcrumbs"
        ],
    "right_spelling": null,
    "weight": 1,
    "difficulty": 85.95114002363806
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatKeywordProcedure.getRelatedKeywords",
 "params": {
   "keyword": "iphone",
   "filters": {"weight": "1"},
   "sort": {"keyword": "asc"} ,
   "se": "g_us",
   "page": "1",
   "size": "10"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "11 pro price iphone": {
                "keyword": "11 pro price iphone",
                "region_queries_count": 70,
                "cost": 0,
                "concurrency": 0,
                "geo_names": [],
                "types": [
                    "related_search",
                    "top_stories",
                    "shopping_top",
                    "also_asks",
                    "kn_graph_carousel_list",
                    "snip_breadcrumbs"
                ],
                "right_spelling": null,
                "weight": 1,
                "difficulty": 85.95114002363806
            },
            "11 sale": {
                "keyword": "11 sale",
                "region_queries_count": 40,
                "cost": 0,
                "concurrency": 8,
                "geo_names": [],
                "types": [
                    "carousel",
                    "also_asks",
                    "video",
                    "snippet_breadcrumbs"
                ],
                "right_spelling": null,
                "weight": 1,
                "difficulty": 18.412967230896843
            }
        },
        "summary_info": {
            "page": 1,
            "total": 2230,
            "left_lines": 998671
        }
    }
}