Отчет URL
2.3.1. Ключевые фразы по URL (url_keywords)
С 31.12.2021 методы API v3 будут недоступны. Воспользуйтесь аналогичным методом API v4.
Метод url_keywords возвращает ключевые фразы в топе поисковой системы по заданному URL. Аналогичен отчету Анализ страниц — SEO-анализ — Ключевые слова. Вы можете выгрузить до 60 000 результатов, используя данный метод.
Общие параметры запроса и инструкция по использованию Serpstat API
Для пагинации используйте параметры:
page_size: количество результатов на страницу (по умолчанию — 100, максимум — 1000);
page: номер страницы (по умолчанию — 1-я страница).
Для фильтрации результатов используйте следующие параметры:
| Параметр | Описание | Возможные значения |
| 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 | Минимальное значение конкуренции | 1-100 |
| concurrency_to | Максимальное значение конкуренции | 1-100 |
| right_spelling | Фильтрация по фразам с неправильным написанием | not_contains - содержит фразы с неправильным написанием; contains - не содержит фразы с неправильным написанием |
Для сортировки результата используйте параметры:
sort: поле, по которому нужно выполнить сортировку;
order: направление сортировки (asc — по возрастанию, desc — по убыванию).
| Параметры ответа | |
| Параметр | Описание |
| result | Содержит в себе ответ |
| total | Количество найденных ключевых фраз, по которым ранжируется страница в топе поисковой системы |
| hits | Массив с данными ответа |
| 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 (от 1 до 100) |
| dynamic | Показывает, как изменилась позиция заданной ключевой фразы |
| status_msg | Ответ: «OK» или «Error», сообщает об удачном или неудачном запросе |
| status_code | Код ответа «200» — успешный запрос. В других случаях — превышение лимитов (количество одновременных запросов или ограничение по лимитам аккаунта) |
| left_lines | Количество оставшихся API строк |
Часть ответа API, за которую снимается 1 лимит:
{
"domain": "nike.com",
"subdomain": "www.nike.com",
"keyword": "man nike",
"keyword_length": 2,
"keyword_id": "136766933",
"keyword_crc": -686015656,
"url": "https://www.nike.com/men",
"position": 1,
"types": [
"snip_breadcrumbs"
],
"found_results": 564000000,
"cost": 0.38,
"concurrency": 100,
"region_queries_count": 40500,
"region_queries_count_wide": 0,
"url_crc": 866156381,
"geo_names": [],
"traff": 6071,
"difficulty": null,
"dynamic": 0,
"modified_date": "2021-07-06",
"_id": "136766933-1"
},2.3.2. Список URL-адресов, конкурирующих с запрашиваемой страницей (url_competitors)
31.12.2021 методы API v3 будут недоступны. Воспользуйтесь аналогичным методом API v4.
Метод url_competitors возвращает URL конкурентов для заданного URL. Аналогичен отчету «Конкуренты» в Анализе страниц.
Общие параметры запроса и инструкция по использованию Serpstat API
| Параметры ответа | |
| Параметр | Описание |
| result | Содержит в себе ответ |
| total | Количество ключевых фраз в топ-10 |
| hits | Массив с данными ответа |
| cnt | Количество одинаковых ключевых фраз у анализируемой страницы и страниц конкурентов |
| domain | Домен конкурента |
| url | Страница конкурента |
| status_msg | Ответ: «OK» или «Error», сообщает об удачном или неудачном запросе |
| status_code | Код ответа «200» — успешный запрос. В других случаях — превышение лимитов (количество одновременных запросов или ограничение по лимитам аккаунта) |
| left_lines | Количество оставшихся API строк |
Часть ответа API, за которую снимается 1 лимит:
{
"cnt": 230,
"domain": "nike.com",
"url": "https://www.nike.com/w/mens-shoes-nik1zy7ok",
"url_crc": -1410140829
},2.3.3. Ключевые слова конкурента, отсутствующие на запрашиваемой странице (url_missing_keywords)
С 31.12.2021 методы API v3 будут недоступны. Воспользуйтесь аналогичным методом API v4.
Метод url_missing_keywords возвращает ключевые фразы, по которым ранжируются конкуренты, но которые отсутствуют у заданного URL. Аналогичен отчету «Упущенные ключи» в Анализе страниц.
Общие параметры запроса и инструкция по использованию Serpstat API
Для пагинации используйте параметры:
page_size: количество результатов на страницу (по умолчанию — 100, максимум — 1000).
page: номер страницы (по умолчанию — 1-я страница).
| Параметры ответа | |
| Параметр | Описание |
| result | Содержит в себе ответ |
| total | Количество найденных результатов |
| hits | Массив с данными ответа |
| region_queries_count | Частотность ключевой фразы в выбранном регионе |
| geo_names | Список топонимов в массиве, если топоним присутствует в ключевой фразе. Если нет — массив пустой. |
| types | Список дополнительных элементов которые отображаются в SERP (например, видео, карусель изображений, карта и другое ) |
| cost | Цена за клик, $ |
| region_queries_count_wide | Частотность ключевой фразы в широком соответствии |
| keyword | Ключевая фраза, по которой ранжируется страница конкурента, но не ранжируется заданная страница |
| concurrency | Конкуренция ключевой фразы в PPC (0-100%) |
| weight | Сила связи — насколько много других конкурентов ранжируются по заданной ключевой фразе |
| status_msg | Ответ: «OK» или «Error», сообщает об удачном или неудачном запросе |
| status_code | Код ответа «200» — успешный запрос. В других случаях — превышение лимитов (количество одновременных запросов или ограничение по лимитам аккаунта) |
| left_lines | Количество оставшихся API строк |
Часть ответа API, за которую снимается 1 лимит:
{
"region_queries_count": 210,
"geo_names": [],
"types": [
"carousel",
"also_asks",
"video",
"snippet_breadcrumbs"
],
"cost": 1.987967,
"keyword_id": 35038615,
"region_queries_count_wide": 0,
"keyword": "buy nike online",
"concurrency": 100,
"weight": 10
},2.3.4. Ключевые фразы по 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 | Идентификатор поисковой базы, по которой будет проходить поиск | string | нет | g_us | |
| filters | Условия фильтрации | array | да |
{ "cost_from": "0.1", "cost_to": "3" }
|
|
| sort |
Порядок сортировки результатов в формате: order — направление сортировки (asc — по возрастанию, desc — по убыванию)
|
array | да | [ ] пустой массив |
"sort": {"cnt": "asc"} |
| page | Номер страницы в ответе | int | да | 1 | "page": "5" |
| size | Количество результатов на страницу в ответе | int | да | 100 |
"size": "10" |
Для фильтрации результатов используйте следующие параметры:
| Параметр | Описание | Возможные значения |
| 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 (от 1 до 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
},2.3.5. Список URL-адресов, конкурирующих с указанной страницей V4 (SerpstatUrlProcedure.getUrlCompetitors)
Метод SerpstatUrlProcedure.getUrlCompetitors возвращает cписок URL-адресов, конкурирующих с заданной страницей. Аналогичен отчету «Конкуренты» в Анализе страниц.
Общие параметры запроса и инструкция по использованию Serpstat API
| Параметры запроса | |||||
|---|---|---|---|---|---|
| Параметр | Описание | Тип данных | Опциональный | Значение по умолчанию | Варианты значений |
| id | Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения. | int/string | нет | 1, test | |
| method | Название метода API | string | нет | SerpstatUrlProcedure.getUrlCompetitors | |
| params | Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...] | array | нет | ||
| url | URL страницы для поиска конкурирующих url-адресов | string | нет | https://www.nike.com | |
| se | Идентификатор поисковой базы, по которой будет проходить поиск | string | нет | g_us | |
| sort |
Порядок сортировки результатов в формате: |
array | да | [ ] пустой массив |
{"cnt": "asc"} |
| page | Номер страницы в ответе | int | да | 1 | "page": "5" |
| size | Количество результатов на страницу в ответе | int | да | 100 |
"size": "10" |
| Параметры ответа | |
| Параметр | Описание |
| id | Идентификатор запроса: соответствует id в запросе |
| result | Содержит в себе ответ |
| data | Массив с данными ответа |
| domain | Домен конкурента |
| url | Страница конкурента |
| cnt | Количество одинаковых ключевых фраз у анализируемой страницы и страниц конкурентов |
| summary_info | Объект с данными ответа |
| page | Номер страницы |
| total | Количество ключевых фраз в топ-100 |
| left_lines | Количество оставшихся API строк |
Лимиты: количество списанных лимитов соответствует количеству полученных результатов по запросу. За один запрос можно получить не более 60000 результатов. Часть ответа API, за которую снимается 1 лимит:
{
"domain": "footlocker.com",
"url": "https://www.footlocker.com/category/brands/nike.html",
"cnt": 75
},2.3.6. Ключевые слова конкурента, отсутствующие на указанной странице V4 (SerpstatUrlProcedure.getUrlMissingKeywords)
Метод SerpstatUrlProcedure.getUrlMissingKeywords возвращает ключевые фразы, по которым ранжируются конкуренты, но не ранжируется заданный URL. Аналогичен отчету «Упущенные ключи» в Анализе страниц.
Общие параметры запроса и инструкция по использованию Serpstat API
| Параметры запроса | |||||
|---|---|---|---|---|---|
| Параметр | Описание | Тип данных | Опциональный | Значение по умолчанию | Варианты значений |
| id | Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения. | int/string | нет | 1, test | |
| method | Название метода API | string | нет | SerpstatUrlProcedure.getUrlMissingKeywords | |
| params | Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...] | array | нет | ||
| url | Анализируемая страница, для которой будут показаны упущенные фразы | string | нет | https://www.nike.com | |
| se | Идентификатор поисковой базы, по которой будет проходить поиск | string | нет | g_us | |
| sort |
Порядок сортировки результатов в формате: |
array | да | [ ] пустой массив |
{"weight": "asc"} |
| page | Номер страницы в ответе | int | да | 1 | "page": "5" |
| size | Количество результатов на страницу в ответе | int | да | 100 |
"size": "10" |
| Параметры ответа | |
| Параметр | Описание |
| id | Идентификатор запроса: соответствует id в запросе |
| result | Инкапсулирует в себе ответ |
| data | Массив с данными ответа |
| region_queries_count | Частотность ключевой фразы в выбранном регионе |
| geo_names | Список топонимов в массиве, если топоним присутствует в ключевой фразе. Если нет — массив пустой. |
| types | Список дополнительных элементов которые отображаются в SERP (например, видео, карусель изображений, карта и другое) |
| cost | Цена за клик, $ |
| region_queries_count_wide | Частотность ключевой фразы в широком соответствии |
| keyword | Ключевая фраза, по которой ранжируется страница конкурента, но не ранжируется заданная страница |
| concurrency | Конкуренция ключевой фразы в PPC (0-100%) |
| weight | Сила связи — насколько много других конкурентов ранжируются по заданной ключевой фразе |
| summary_info | Объект с данными ответа |
| page | Номер страницы |
| left_lines | Количество оставшихся API строк |
Лимиты: количество списанных лимитов соответствует количеству полученных результатов по запросу. За один запрос можно получить не более 60000 результатов. Часть ответа API, за которую снимается 1 лимит:
{
"region_queries_count": 1220000,
"geo_names": [],
"types": [
"ads_bot",
"also_asks",
"kn_graph_carousel_list",
"shopping_rhs",
"shopping_top",
"snip_breadcrumbs"
],
"cost": 0.58999999999999997,
"region_queries_count_wide": 0,
"keyword": "shoes",
"concurrency": 100,
"weight": 2
},2.3.7. Трафик по маске URL V4 (SerpstatUrlProcedure.getSummaryTraffic)
Метод SerpstatUrlProcedure.getSummaryTraffic возвращает отчет по трафику по маске URL.
Общие параметры запроса и инструкция по использованию Serpstat API
| Параметры запроса | ||||
| Параметр | Описание | Тип данных | Опциональный | Варианты значений |
| id | Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения. | int/string | нет | 1, test |
| method | Название метода API | string | нет | SerpstatUrlProcedure.getSummaryTraffic |
| params | Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...] | array | нет | |
| domain | Домен, по которому нужно получить данные. | string | нет | adidas.com |
| se |
Идентификатор базы данных, из которой нужно получить данные.
|
string
|
нет
|
g_us |
| UrlContains |
Искомая часть, входящая в URL страницы.
|
string
|
нет
|
/women-shoes |
| Параметры ответа | |
| Параметр | Описание |
| id | Идентификатор запроса: соответствует id в запросе |
| result |
Содержит в себе ответ
|
| totalTraff |
Суммарный органический трафик на найденные по маске URL страницы
|
| urls |
Количество URL, которые попали под условие поиска.
|
| summary_info |
Объект с данными ответа
|
| left_lines |
Количество оставшихся лимитов.
|
Лимиты: При подсчете использованных лимитов учитываются любые запросы по API в соответствие с вашим тарифным планом. В данном методе снимается 1000 API лимитов за 1 запрос. Часть ответа API, за которую снимается 1000 лимитов:
{
"totalTraff": 5585240,
"urls": 2879,
"summary_info": {
"left_lines": 987129
}
}