Поисковые подсказки

Метод SerpstatKeywordProcedure.getSuggestions выполняет полнотекстовый поиск по поисковым подсказкам анализируемого ключевого слова. Аналогичен отчету Анализ ключевых фраз - SEO-анализ - Поисковые подсказки.

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

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

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

Параметры ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Инкапсулирует в себе ответ
data	Массив с данными ответа
keyword	Поисковая подсказка
geo_names	Список топонимов в масcиве, если топоним присутствует в ключевой фразе. Если нет — маcсив пустой.
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",
   "filters": {
       "minus_keywords": ["case", "red"]
   },
   "se": "g_us",
   "page": "1",
   "size": "10"
  }
 }

Response data:

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