Ключові фрази по URL V4 (SerpstatUrlProcedure.getUrlKeywords)

Метод SerpstatUrlProcedure.getUrlKeywords повертає ключові фрази в топі пошукової системи за заданим URL. Аналогічний до звіту Аналіз домену — SEO-аналіз — Ключові слова.

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

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

Параметри запиту
Параметр	Опис	Тип даних	Опціональний	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. Допускається введення будь-якого числового (number) або текстового (string) значення.	int/string	ні		1, test
method	Назва методу API	string	ні		SerpstatUrlProcedure.getUrlKeywords
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]	array	ні
url	URL сторінки	string	ні		https://www.nike.com/men
se	Ідентифікатор пошукової бази, по якій буде проходити пошук (доступні бази Google і Yandex на вибір, наприклад: g_us, y_157)	string	ні		g_us
filters	Умови фільтраціі	array	так		{ "cost_from": "0.1", "cost_to": "3" }
sort	Порядок сортування результатів в форматі: {{{Field}}: {{order}}} field — поле, за яким потрібно виконати сортування: * region_queries_count * cost * keyword_length * concurrency * difficulty * traff * region_queries_count_wide * dynamic * position * found_results order — напрямок сортування (asc — за зростанням, desc — за спаданням)		так	[ ] порожній масив	"sort": {"cnt": "asc"}
page	Номер сторінки у відповіді	int	так	1	"page": "5"
size	Кількість результатів на сторінку у відповіді	int	так	100	"size": "10" min: 1, max: 1000

Для фільтрації результатів використовуйте наступні параметри:

Параметр	Опис	Можливі значення
position_from	Мінімальна позиція ключового слова	1-100
position_to	Максимальна позиція ключового слова	1-100
queries_from	Мінімальна кількість запитів в місяць	0-100000000
queries_to	Максимальна кількість запитів на місяць	0-100000000
cost_from	Мінімальна вартість за клік	0-200
cost_to	Максимальна вартість за клік	0-200
concurrency_from	Мінімальне значення конкуренції	0-100
concurrency_to	Максимальне значення конкуренції	0-100

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

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

{
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "keyword": "man nike",
    "keyword_length": 2,
    "url": "https://www.nike.com/men",
    "position": 1,
    "types": [
        "snip_breadcrumbs"
        ],
    "found_results": 656000000,
    "cost": 0.38,
    "concurrency": 100,
    "region_queries_count": 40500,
    "region_queries_count_wide": 0,
    "geo_names": [],
    "traff": 6071,
    "difficulty": null,
    "dynamic": 0
},

Example

Request data:

{
    "id": "1",
    "method": "SerpstatUrlProcedure.getUrlKeywords",
    "params": {
        "se": "g_us",
        "url": "https://www.nike.com/men",
        "filters": {"queries_from": "10000", "queries_to": "100000"},
        "sort": {"position": "asc"},
        "page": "1",
        "size": "10"
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "nike.com",
                "subdomain": "www.nike.com",
                "keyword": "man nike",
                "keyword_length": 2,
                "url": "https://www.nike.com/men",
                "position": 1,
                "types": [
                    "snip_breadcrumbs"
                ],
                "found_results": 656000000,
                "cost": 0.38,
                "concurrency": 100,
                "region_queries_count": 40500,
                "region_queries_count_wide": 0,
                "geo_names": [],
                "traff": 6071,
                "difficulty": null,
                "dynamic": 0
            },
            {
                "domain": "nike.com",
                "subdomain": "www.nike.com",
                "keyword": "mens nike",
                "keyword_length": 2,
                "url": "https://www.nike.com/men",
                "position": 1,
                "types": [
                    "snip_breadcrumbs"
                ],
                "found_results": 93,
                "cost": 0.38,
                "concurrency": 100,
                "region_queries_count": 40500,
                "region_queries_count_wide": 0,
                "geo_names": [],
                "traff": 6071,
                "difficulty": 81.58723943676779,
                "dynamic": 0
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 61,
            "left_lines": 998269
        }
    }
}