Сумарний звiт

Метод SerpstatKeywordProcedure.getKeywordsInfo повертає дані по ключовому слову (кількість запитів, вартість за клік, рівень конкуренції та ін.). Аналогічний до звіту «Сумарний звіт» в Аналізі ключових слів.

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

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

Параметри запиту
Параметр	Опис	Тип даних	Опціональний	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. Допускається введення будь-якого числового (number) або текстового (string) значення	int/string	ні		1, test
method	Назва методу API	string	ні		SerpstatKeywordProcedure.getKeywordsInfo
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]	array	ні
keyword	Масив фраз, для яких буде відбуватися пошук	array	ні		["iphone", "iphone 11"] максимум 1000 ключових фраз у масиві
se	Ідентифікатор пошукової бази, по якій буде проходити пошук.	string	ні		g_us
sort	Порядок сортування результатів в форматі: {{{Field}}: {{order}}} field — поле, за яким потрібно виконати сортування (всі числові значення, орім suggestions_count и keywords_count) order — напрямок сортування (asc — за зростанням, desc — за спаданням)	array	так	[ ] порожній масив	{"cost": "desc"}
filters	Умови фільтраціі	array	так		"right_spelling": true$ "right_spelling": false "minus_keywords": ["case", "red"] "cost": "10"; "cost_to": "10"; "cost_from": 1 "concurrency": "7"; "concurrency_to": "7"; "concurrency_from": 1 "found_results": "100"; "found_results_to": "500"; "found_results_from": 300 "region_queries_count": "1000"; "region_queries_count_to": "2000"; "region_queries_count_from": 300 "region_queries_count_wide": "1000"; "region_queries_count_wide_to": "1500"; "region_queries_count_wide_from": 100

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

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

{
    "keyword": "iphone",
    "cost": 1.8822413793103445,
    "concurrency": 100,
    "found_results": 79,
    "region_queries_count": 1220000,
    "region_queries_count_wide": 0,
    "region_queries_count_phrase": 0,
    "types": [
        "shopping_top",
        "kn_graph_carousel_list",
        "also_asks"
        ],
    "geo_names": [],
    "social_domains": [
        "wikipedia",
        "amazon",
        "reddit"
        ],
    "right_spelling": null,
    "lang": null,
    "difficulty": 89.5890633703002,
    "suggestions_count": 2652668,
    "keywords_count": 8323766
},

Example

Request data:

{
    "id": "1",
    "method": "SerpstatKeywordProcedure.getKeywordsInfo",
    "params": {
        "keywords": [
            "iphone",
            "iphone 11"
        ],
        "se": "g_us",
        "filters": {
            "cost_from": 0.7,
            "region_queries_count_from": 100,
            "minus_keywords": ["case","red"]
        }
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "keyword": "iphone 11",
                "cost": 0.71,
                "concurrency": 100,
                "found_results": 4460000000,
                "region_queries_count": 1500000,
                "region_queries_count_wide": 0,
                "region_queries_count_phrase": 0,
                "types": [
                    "video",
                    "shopping_top",
                    "also_asks"
                ],
                "geo_names": [],
                "social_domains": [
                    "wikipedia",
                    "amazon",
                    "pinterest"
                ],
                "right_spelling": null,
                "lang": null,
                "keyword_length": 2,
                "difficulty": 30.39
                ],
                "suggestions_count": 0,
                "keywords_count": 3406
            }
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 999718
        }
    }
}