Ключові слова

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

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

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

Параметри запиту
Параметр	Опис	Тип даних	Обов'язковий	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор.	int/string	так		будь-яке текстове або числове значення
method	Назва методу API	string	так		SerpstatUrlProcedure.getUrlKeywords
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]	array	так
se	Ідентифікатор пошукової бази, по якій буде проходити пошук	string	так		g_us (список пошукових баз)
url	URL сторінки	string	так		URL-адреса сторінки (Наприклад "https://www.nike.com")
filters	Умови фільтраціі	array	ні	без фільтрації	варіанти фільтрації перелічені в таблиці нижче
sort	Сортування за даними (за зростанням і спаданням)	array	ні	"traff"	"difficulty" — Сортування результатів за рівнем конкуренції ключової фрази для просування в топ-10 "cost" — Сортування результатів за ціною за клік (в доларах США) "position" — Сортування результатів за позицією
order	Напрямок сортування	array	ні	"desc"	asc або desc
page	Номер сторінки у відповіді	int	ні	1	будь-яке числове значення
size	Кількість результатів на сторінку у відповіді	int	ні	100	числове значення в діапазоні 1-1000

Параметри фільтрації
Параметр	Опис	Тип даних	Варіанти значень
cost	Вартість ключової фрази за клік (у США $; точна відповідність)	float	будь-яке числове значення
cost_from	Вартість ключової фрази за клік (у США $; точна відповідність) від	float	будь-яке числове значення
cost_to	Вартість ключової фрази за клік (у США $; точна відповідність) до	float	будь-яке числове значення
position	Позиція ключового слова	int	будь-яке ціле число в діапазоні 1-100
position_from	Позиція ключового слова від	int	будь-яке ціле число в діапазоні 1-100
position_to	Позиція ключового слова до	int	будь-яке ціле число в діапазоні 1-100
concurrency	Конкуренція (наскільки складне просування фрази у топ від 1-100)	int	будь-яке ціле число в діапазоні 1-100
concurrency_from	Конкуренція (наскільки складне просування фрази у топ від 1-100) від	int	будь-яке ціле число в діапазоні 1-100
concurrency_to	Конкуренція (наскільки складне просування фрази у топ від 1-100) до	int	будь-яке ціле число в діапазоні 1-100
keyword_length	Кількість слів у ключовій фразі	int	будь-яке числове значення
difficulty	Складність ключової фрази	float	будь-яке числове значення
difficulty_from	Складність ключової фрази від	float	будь-яке числове значення
difficulty_to	Складність ключової фрази до	float	будь-яке числове значення
traff	Трафік за ключовою фразою	int	будь-яке ціле число
region_queries_count	Частотність ключової фрази у вибраному регіоні	int	будь-яке ціле число
region_queries_count_from	Частотність ключової фрази у вибраному регіоні від	int	будь-яке ціле число
region_queries_count_to	Частотність ключової фрази у вибраному регіоні до	int	будь-яке ціле число
region_queries_count_wide	Частотність ключової фрази у широкій відповідності	int	будь-яке ціле число
region_queries_count_wide_from	Частотність ключової фрази у широкій відповідності від	int	будь-яке ціле число
region_queries_count_wide_to	Частотність ключової фрази у широкій відповідності до	int	будь-яке ціле число
url_contains	Посилання на сторінку аналізуємого домену, який ранжується по даній ключовій фразі	string	будь-яке текстове значення
right_spelling	Відображати або не відображати ключові фрази з неправильним написанням	boolean	true або false
keyword_contain	Містить усі ключові фрази (точна відповідність)	string	будь-яке текстове значення
keyword_not_contain	Не містить усі ключові фрази (точна відповідність)	string	будь-яке текстове значення
keyword_contain_one_of	Містить одну ключову фразу з (точна відповідність)	string	будь-яке текстове значення
keyword_not_contain_one_of	Не містить одну ключову фразу з (точна відповідність)	string	будь-яке текстове значення
keyword_contain_broad_match	Містить усі ключові фрази (широка відповідність)	string	будь-яке текстове значення
keyword_not_contain_broad_match	Не містить усі ключові фрази (широка відповідність)	string	будь-яке текстове значення
keyword_contain_one_of_broad_match	Містить одну ключову фразу з (широка відповідність)	string	будь-яке текстове значення
keyword_not_contain_one_of_broad_match	Не містить одну ключову фразу з (широка відповідність)	string	будь-яке текстове значення

Параметри відповіді
Параметр	Опис
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%)
first_position	За ключовою фразою знайдено домен, позиція якого краще ніж у аналізуємого.
first_url	За ключовою фразою знайдено url, позиція якого краще ніж у аналізуємого.
dynamic	Показує, як змінилася позиція заданої ключової фрази (Нова позиція - null, Позиція не змінилася - 0, Позиція впала - негативне значення (наприклад, -20), Позиція зросла - позитивне значення (наприклад, 20))
summary_info	Об'єкт з даними відповіді
page	Номер сторінки
total	Кількість знайдених ключових фраз, за якими ранжується сторінка в топі
left_lines	Кількість API лімітів, що залишилися

Ліміти: кількість списаних лімітів відповідає кількості отриманих результатів за запитом. За допомогою API запитів ви можете отримати лише перші 60000 результатів, незалежно від кількості та обсягу самих запитів. Для отримання більшої кількості даних - скористайтесь опцією експорту в розділах Аналіз домену, Аналіз ключової фрази або Аналіз URL, або зверніться до куратора за персональним вивантаженням результатів. Частина відповіді 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": {"cost_from": 1, "cost_to": 1000},
        "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": "buy nike men shoes",
                "keyword_length": 4,
                "url": "https://www.nike.com/men",
                "position": 1,
                "types": [
                    "kn_graph_carousel_list",
                    "a_box_card",
                    "snip_image_thumbnail",
                    "snip_breadcrumbs"
                ],
                "found_results": 91,
                "cost": 1.485899,
                "concurrency": 100,
                "region_queries_count": 50,
                "region_queries_count_wide": 0,
                "geo_names": [],
                "traff": 7,
                "difficulty": 80.52167499013474,
                "dynamic": 0
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 61,
            "left_lines": 998269
        }
    }
}