Суммарный отчет

Метод SerpstatKeywordProcedure.getKeywordsInfo возвращает данные по ключевому слову (частотность ключевой фразы в выбранном регионе, цена за клик, конкуренция ключевой фразы в PPC и т.п.). Аналогичен отчету «Суммарный отчет» в Анализе ключевых фраз, за вычетом графиков и диаграмм.

Общие параметры запроса и инструкция по использованию Serpstat API

Перечень доступных баз и стран

Параметры запроса

Параметр

Описание

Тип данных

Опциональный

Значение по умолчанию

Варианты значений

Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения.

int/string

нет

1, test

method

Название метода API

string

нет

SerpstatKeywordProcedure.getKeywordsInfo

params

Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]

array

нет

keywords

Массив фраз, для которых будет происходить поиск

array

нет

["iphone", "iphone 11"]
максимум 1000 ключевых фраз в массиве

Идентификатор поисковой базы, по которой будет проходить поиск.

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
        }
    }
}