Содержание
滚球体育平台
API управления проектами позволяет работать с проектами (создание, редактирование, удаление), получать статистику по отдельным проектам или ключевым словам.
Список сайтов пользователя
Метод позволяет получить список всех проектов пользователя.
Запрос
GET https://api4.seranking.com/sites
Результат
В случае успеха сервер вернет HTTP 200 и список сайтов.
Пример ответа
[{
«id»: 1,
“title”: “zniqpf tfallp mykqeg”,
“name”: “Cronin.info”,
“group_id”: 0,
“is_active”: 1,
“exact_url”: 0,
“subdomain_match”: 0,
“depth”: 100,
“check_freq”: “check_daily”,
“check_day”: null,
“guest_link”: “https://seranking.com/guest.html? site_id=1&hv=0&hash=432&tab=detailed”,
“keyword_count”: 0,
}]
Параметры
| Имя | Описание |
| id | Уникальный идентификатор сайта (ID) |
| title | Название сайта |
| name | URL сайта |
| group_id | ID группы сайтов |
| is_active | Статус сайта 1 – активный, 0 – отложенный |
| exact_url | 1 – Позиции будут проверятся только для указанного URL без учета подпапок и поддоменов. |
| subdomain_match | 1 – Учитывать сабдомены в выдаче |
| depth | Глубина сбора позиций |
| check_freq | Периодичность проверок |
| check_day |
Если проверка еженедельная (check_weekly), то в этом параметре день недели. (от 1-понедельник до 7 – воскресенье).
Если проверка ежемесячная (check_monthly), то в параметре день месяца. (1-31) |
| guest_link | Гостевая ссылка для просмотра статистики сайта без авторизации |
| keyword_count | Количество добавленных ключевых слов в проект |
Список поисковых систем сайта
Метод позволяет получить список поисковых систем проекта.
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/search-engines
Результат
В случае успеха сервер вернет HTTP 200 и список поисковых систем проекта
Пример ответа
{
“site_engine_id”: 1,
“search_engine_id”: 339,
“region_id”: 0,
“region_name”: null,
“lang_code”: “ru”,
“merge_map”: 0,
“business_name”: null,
“phone”: null,
“paid_results”: 0,
“featured_snippet”: 0
}
Параметры
| Имя | Описание |
| search_engine_id | ID поисковой системы (см. GET /system/search-engines) |
| region_id | ID региона. Только для Yandex (см. GET /system/yandex-regions) |
| region_name | Географическое название (область / город) на англ. языке. Только для Google |
| lang_code | Код языка (см. /system/google-langs) |
| merge_map | Учитывать выдачу Google Maps. 0 – не учитывать, 1 – учитывать, 2 – учитывать и отображать отдельно. |
| business_name | Название бизнеса. Для выдачи Google Maps |
| phone | Телефон компании. Для выдачи Google Maps |
| paid_results | Отслеживать позиции в Google Adwords (1 – да, 0 – нет) |
| featured_snippet | Учитывать блоки с ответами (1 – учитывать, 0 – нет) |
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Invalid keyword_id |
| 400 | Invalid date |
| 400 | No ids in request |
| 404 | Unknown search_engine_id |
| 404 | Unknown site_engine_id |
Добавление поисковой системы в проект
Метод позволяет добавить новые поисковые системы в проект.
Формат запроса
POST https://api4.seranking.com/sites/{site_id}/search-engines
Пример ответа
{
“search_engine_id”: 339,
“region_id”: 0,
“region_name”: null,
“lang_code”: “ru”,
“merge_map”: 0,
“business_name”: null,
“phone”: null,
“paid_results”: 0,
“featured_snippet”: 0
}
Параметры
| Имя | Обязательный | Описание |
| search_engine_id | Да | ID поисковой системы (см. GET /system/search-engines) |
| region_id | Нет | ID региона. Только для Yandex (см. GET /system/yandex-regions) |
| region_name | Нет | Географическое название (область / город) на англ. языке. Только для Google (см. GET /system/google-regions) |
| lang_code | Нет | Код языка (см. /system/google-langs) |
| merge_map | Нет | Учитывать выдачу Google maps. 0 – не учитывать, 1 – учитывать, 2 – учитывать и отображать отдельно. Только для Google |
| business_name | Нет | Название бизнеса. Для выдачи Google Maps. Только для Google |
| phone | Нет | Телефон компании. Для выдачи Google Maps |
| paid_results | Нет | Отслеживать позиции в Google Adwords (1 – да, 0 – нет) |
| featured_snippet | Нет | Учитывать блоки с ответами (1 – учитывать, 0 – нет). Только для Google |
Результат
В случае успеха сервер вернет HTTP код 201 и site_engine_id добавленной поисковой системы.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 404 | Unknown search_engine_id |
Изменение поисковой системы в проекте
Метод позволяет добавить новые поисковые системы в проект.
Формат запроса
PUT https://api4.seranking.com/sites/{site_id}/search-engines/{site_engine_id}
{
“region_id”: 0,
“region_name”: null,
“lang_code”: “ru”,
“merge_map”: 0,
“business_name”: null,
“phone”: null,
“paid_results”: 0,
“featured_snippet”: 0
}
Параметры
Cм. добавление поисковой системы.
Результат
В случае успеха сервер возвращает HTTP 200 OK.
Удаление поисковой системы в проекте
Формат запроса
DELETE https://api4.seranking.com/sites/{site_id}/search-engines/{site_engine_id}
Результат
В случае успеха сервер возвращает HTTP 204.
Список ключевых слов сайта
Метод позволяет получить список ключевых слов с целевыми страницами определенного проекта.
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/keywords?site_engine_id=NNN
Параметры запроса
| search_engine_id |
Необязательный параметр.
ID поисковой системы (см. GET /system/search-engines) Если он передан, то возвращается дата first_check_date |
Результат
В случае успеха сервер вернет массив со списком ключевых слов проекта со статистикой по каждому из них.
| Имя | Описание |
| id | Уникальный идентификатор запроса |
| name | Ключевое слово |
| group_id | ID группы запросов |
| link | Целевой URL |
| first_check_date | Дата первой проверки запроса в поисковой системе site_engine_id если она указана в запросе |
| tags | Список ID тегов |
Пример ответа
[
{
“id”: “1”,
“name”: “key1”,
“group_id”: “2”,
“link”: null,
“first_check_date”: “2015-02-17”,
“tags”: [
“11”,
“12”
]
},
{
“id”: “2”,
“name”: “key2”,
“group_id”: “2”,
“link”: “https://mysite.com/”,
“first_check_date”: null,
“tags”: []
},
…
]
Список тегов в проекте
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/keywords-tags
Результат
Сервер возвращает массив тегов.
| Имя | Описание |
| id | Уникальный идентификатор тега (ID) |
| name | Название тега |
| color | Цвет тега (в hex формате) |
Пример ответа
[
{
“id”: 3686,
“name”: “Ad”,
“color”: “64b5f6”
},
{
“id”: 3695,
“name”: “Rates”,
“color”: “FFD53B”
}
]
Сводная статистика
Метод позволяет получить сводную статистику по проекту.
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/stat
Результат
| Имя | Описание |
| site_id | Уникальный идентификатор сайта (ID) |
| today_avg | Средняя позиция за последнюю дату снятия позиций (сегодня) |
| yesterday_avg | Средняя позиция за предыдущую дату снятия позиций (вчера) |
| total_up | Сколько позиций поднялось в выдаче |
| total_down | Сколько позиций опустилось в выдаче |
| process | Текущий процент обработки позиций сайта |
| top5 | Запросов в ТОП 5 |
| top10 | Запросов в ТОП 10 |
| top30 | Запросов в ТОП 30 |
| visibility | Прогноз трафика |
| visibility_percent | Видимость в % |
| index_yandex | Количество страниц в индексе Яндекс |
| yandex_x | Yandex_x (икс) |
| index_google | Количество страниц в индексе Google |
Пример ответа
{
“site_id”: 123,
“name”: “site1.com”,
“group_id”: null,
“title”: “my site”,
“today_avg”: 123,
“yesterday_avg”: 111,
“total_up”: 0,
“total_down”: 5,
“process”: “99.9”,
“top5” : 1,
“top10” : 2,
“top30” : 3,
“visibility” : 2,
“visibility_percent” : 30.0,
“da” : 4,
“index_yandex” : 100,
“index_google” : 200,
“index_x” : null,
}
Статистика по ключевым словам
Метод позволяет получить статистику проверки позиций по ключевым словам проекта за выбранный период.
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/positions?date_from=2018-01-01&date_to=2018-01-07&site_engine_id=1&with_landing_pages=1&with_serp_features=1&historical=1
Параметры
Query-параметры. Все параметры не обязательны.
| Имя | Тип | Описание |
| date_from | yyyy-mm-dd | Дата начала периода (по умолчанию – сегодня минус неделя) |
| date_to | yyyy-mm-dd | Дата конца периода (по умолчанию – сегодня) |
| site_engine_id | ID поисковой системы. Если не указано, вернёт данные по всем поисковым системам | |
| in_top | Фильтр по позиции. Напр. in_top=10 вернёт данные только о запросах, входящих в ТОП 10 на момент последней проверки в выбранном периоде. | |
| with_landing_pages | Информация url страницы в поисковой выдаче | |
| with_serp_features | Специальные элементы поисковой выдачи, найденные в результатах поиска по ключевому слову | |
| historical | число (1 или 0) | Добавляет в ответ дополнительную информацию по позициям в определенные даты: первая проверка, 6 месяцев назад, 3 месяца назад, 1 месяц назад, 7 дней назад, вчера, сегодня. |
Результат
В случае успеха сервер возвращает массив из всех (или указанной) поисковых систем проекта, содержащий статистику по ключевым словам за указанный период.Возвращает максимум 100000 записей позиций (positions). Если в проекте большое количество ключевых слов, желательно указывать ID поисковой системы и период проверки.
| Имя | Описание |
| id | Уникальный идентификатор запроса |
| position | Массив с элементами |
| date | Дата |
| change | Изменение позиции по сравнению с пред. датой (может быть отрицательное) |
| pos | Текущая позиция |
| price | Цена, рассчитанная из настроек финансового отчёта |
| is_map | Указывает, где найдена позиция, принимает значение 0 для органической выдачи, 1 – для блока с картами |
| map_position | Позиция в блоке с картами, при включенной опции “Отображать позиции для органической и выдачи карт отдельно” (merge_map = 2) |
| paid_position | Позиция в платной выдаче Google |
| landing_pages |
Массив с элементами:
– date – дата в формате yyyy-mm-dd – url – url страницы в поисковой выдаче по ключевому слову |
| features | Массив с элементами поиска. Если значение true – в элементе поиска найдена ссылка на сайт проекта |
| volume | Частотность |
| competition | Конкуренция |
| suggested_bid | Цена за один клик |
| kei | Индекс эффективности ключевого слова |
| results | Количество результатов по данному запросу в Google |
| total_sum | Цена за запросы, рассчитанная из настроек финансового отчёта |
Пример ответа
[
{
“site_engine_id”: 1,
“keywords”: [
{
“id”: “12”,
“positions”: [
{
“date”: “2017-12-19”,
“pos”: 18,
“change”: 0,
“price”: 0,
“is_map”: 0,
“map_position”: 0,
“paid_position”: 0
}
],
“volume”: 390,
“competition”: 3,
“suggested_bid”: 1,
“kei”: 1,
“resultsi”: 100,
“total_sum”: 0,
“landing_pages”: [
{
“url”: “https://domain.com/page.html”,
“date”: “2017-12-14”
}
],
“features”: {
“tads”: true,
“knowledge_graph”: true,
“images”: true,
“sitelinks”: true,
“reviews”: false
},
},
…
]
}
]
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Invalid site_engine_id |
Графики количества объявлений
Метод позволяет получить данные по количеству верхних и нижних рекламных объявлений по дням.
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/ads?date_from=2020-05-20&date_to=2020-05-21&site_engine_ids[]=1&site_engine_ids[]=2&keywords_ids[]=1&keywords_ids[]=1
Параметры запроса
Query-параметры. Все параметры не обязательны.
| Имя | Тип | Описание |
| date_from | yyyy-mm-dd | Дата начала периода (по умолчанию – сегодня минус неделя). |
| date_to | yyyy-mm-dd | Дата конца периода (по умолчанию – сегодня). |
| site_engine_ids |
Фильтр по ID поисковых систем сайта.
Если не указано, вернет данные по всем поисковым системам. |
|
| keywords_ids |
Фильтр по ID ключевых слов.
Если не указано, вернет данные по всем ключевым словам. |
Результат
В случае успеха сервер возвращает массив данных из всех (или указанных) поисковых систем проекта. В этом массиве указаны данные по количеству верхних и нижних рекламных объявлений в поисковой выдаче по всем (или выбранным) ключевым словам по датам в указанном периоде.
Возвращает данные максимум 100 000 записей. Если в проекте большое количество ключевых слов, желательно указывать ID поисковых систем, ключевых слов и период проверки.
| Имя | Описание |
| site_engine_id | ID поисковой системы |
| keywords | Массив ключевых слов с данными по количеству объявлений |
| id | ID ключевого слова |
| ads | Массив с данными по количеству объявлений по датам |
| date | Дата |
| tabs | Количество верхних объявлений |
| bads | Количество нижних объявлений |
Пример ответа
[{
“site_engine_id”: 1,
“keywords”: [
{
“id”: 1,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 2,
“bads”: 3
},
{
“date”: “2020-05-21”,
“tads”: 3,
“bads”: 2
},
]
},
{
“id”: 2,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 0,
“bads”: 0
},
{
“date”: “2020-05-21”,
“tads”: 0,
“bads”: 1
},
]
},
]
},
{
“site_engine_id”: 2,
“keywords”: [
{
“id”: 1,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 1,
“bads”: 1
},
{
“date”: “2020-05-21”,
“tads”: 2,
“bads”: 2
},
]
},
{
“id”: 2,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 0,
“bads”: 2
},
{
“date”: “2020-05-21”,
“tads”: 5,
“bads”: 1
},
]
},
]
}]
Графики позиций
Метод позволяет получить данные для отображения графика позиций проекта.
GET https://api4.seranking.com/sites/{site_id}/chart?date_from=2019-09-09&date_to=2019-09-11&type=top10_percent&group_id=1191&keywords_ids[]=17075&tags_ids[]=1&site_engine_id=1061
Параметры запроса
| Имя | Обязательный | Описание |
| date_from | Нет | Начало периода. 7 дней назад, если не указано. |
| date_to | Нет | Конец периода. Текущая дата, если не указано. |
| type | Нет | Тип графика. Если не указано avg_pos. |
| group_id | Нет | ID группы ключевых слов. |
| keywords_ids[] | Нет | Фильтр по ID ключевых слов. |
| tags_ids[] | Нет | Фильтр по ID тегов ключевых слов. |
| site_engine_id | Нет | Фильтр по ID поисковой системы в проекте. |
Типы графиков:
- avg_pos – средняя позиция
- visibility – прогноз трафика
- visibility_percent – видимость
- top10 – количество ключей в ТОП 10
- top10_percent – процент ключей в ТОП 10
Результат
Сервер вернет серии данных для каждой поисковой системы в проекте и для среднего значения показателя по всем поисковикам.
| Имя | Описание |
| name | Название линии графика |
| data | Данные в виде пар дата – значение |
| type | Тип линии графика: search_engine – данные поисковой системы, avg – среднее значение по всем. |
| search_engine_id | ID поисковой системы в проекте, только для type = avg. |
Пример ответа
[
{
“name”: “Google Mobile USA – Ср.”,
“data”: [
{
“date”: “2019-09-09”,
“value”: “46”
},
{
“date”: “2019-09-10”,
“value”: “22”
},
{
“date”: “2019-09-11”,
“value”: “22”
}
],
“type”: “search_engine”,
“search_engine_id”: 1540
},
{
“name”: “Google USA – Ср.”,
“data”: [
{
“date”: “2019-09-09”,
“value”: “38”
},
{
“date”: “2019-09-10”,
“value”: “21”
},
{
“date”: “2019-09-11”,
“value”: “20”
}
],
“type”: “search_engine”,
“search_engine_id”: 200
},
{
“name”: “Среднее по всем”,
“data”: [
{
“date”: “2019-09-09”,
“value”: 42
},
{
“date”: “2019-09-10”,
“value”: 22
},
{
“date”: “2019-09-11”,
“value”: 21
}
],
“type”: “avg”,
“search_engine_id”: null
}
]
Исторические даты
Метод возвращает список дат, необходимых для постройки графика исторических позиций. Даты соответствуют следующему списку: сегодня, вчера, 7 дней назад, 1 месяц назад, 3 месяца назад, 6 месяцев назад, первый день проверки. Если в указанную дату не было проверки позиций, то будет возвращена ближайшая дата проверки позиций.
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/historicalDates
Параметры отсутствуют
Результат
В случае успеха сервер возвращает массив, содержащий список доступных дат. Массив может содержать следующие элементы: ‘current’, ‘day_ago’, ‘7days’, ’30days’, ’90days’, ‘180days’, ‘first’. В качестве значений будут переданы даты в формате YYYY-MM-DD.
Пример ответа
{
“current” : “2019-02-20”,
“day_ago” : “2019-02-19”,
“7days” : “2019-02-14”,
}
Даты снятия позиций
Метод позволяет получить список дат, когда были проверки позиций.
Формат запроса
GET https://api4.seranking.com/sites/{site_id}/check-dates?date_from=2019-09-01&date_to=2019-09-30&site_engine_id=1061
Параметры запроса
| Имя | Обязательный | Описание |
| date_from | Нет | Начало периода. 7 дней назад, если не указано. |
| date_to | Нет | Конец периода. Текущая дата, если не указано. |
| site_engine_id | Нет | Идентификатор поисковой системы в проекте. |
Пример ответа
[
“2019-09-01”,
“2019-09-02”,
“2019-09-03”,
“2019-09-04”,
“2019-09-05”,
“2019-09-06”,
“2019-09-07”,
“2019-09-08”,
“2019-09-09”,
“2019-09-10”,
“2019-09-11”
]
Добавление запросов в проект
Метод позволяет добавлять новые ключевые слова в проект.
Формат запроса
POST https://api4.seranking.com/sites/{site_id}/keywords
[{
“keyword”:”text”,
“group_id”:1,
“target_url”: “https://site.com/”,
“is_strict”: 0
}]
Параметры в запросе
| Имя | Обязательный | Описание |
| keyword | Да | Ключевое слово (запрос) |
| group_id | Нет | ID группы ключевых слов (если параметр не указан, будет использована группа по умолчанию) |
| target_url | Нет | Целевая ссылка |
| is_strict | Нет | Проверять позиции только для указанных целевых ссылок (0 или 1, по умолчанию – 0) |
Результат
В случае успеха сервер вернет массив с количеством добавленных ключевых слов и их ID в проекте.
| Имя | Обязательный | Описание |
| added | Да | Количество успешно добавленных запросов в проект |
| ids | Нет | Массив ID добавленных запросов |
Пример ответа
{
“added”: 3,
“ids”: [
123,
456,
789
]
}
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | No keywords specified |
Изменение ключевого слова в проекте
Метод позволяет изменять настройки ключевого слова в проекте.
Формат запроса
PATCH https://api4.seranking.com/api/sites/{site_id}/keywords/{keyword_id}
{
“keyword”:”text”,
“target_url”: “https://site.com/”
}
Параметры в запросе
| Имя | Описание |
| keyword | Ключевое слово (запрос) |
| group_id | ID группы ключевых слов для переноса ключевого слова в группу проекта (обязательно значение из списка ID групп ключевых слов проекта) |
| target_url | Целевая ссылка |
| is_strict | Проверять позиции только для указанных целевых ссылок (0 или 1, по умолчанию – 0) |
Результат
В случае успеха сервер возвращает HTTP 200.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Invalid or empty keyword data |
| 403 | Access denied (wrong site_id) |
| 404 | Unknown keyword (wrong keyword_id) |
Добавление проекта
Метод позволяет добавить новый проект в аккаунт пользователя.
Формат запроса
POST https://api4.seranking.com/sites
{
“url”:”https://test.site/”,
“title”:”seo site”
}
Параметры в запросе
| Имя | Обязательный | Описание |
| url | Да | URL сайта |
| title | Да | Название проекта |
| depth | Нет | Глубина сбора позиций (100, 200), по умолчанию – 100 |
| subdomain_match | Нет | Учитывать сабдомены в выдаче? (0 или 1), по умолчанию – 0 |
| exact_url | Нет | Точный URL? (0 или 1), по умолчанию – 0 |
| check_freq | Нет | Периодичность проверки позиций (‘check_daily’, ‘check_1in3’, ‘check_weekly’, ‘check_monthly’, ‘manual’), по умолчанию – check_daily |
| auto_reports | Нет | Еженедельный отчет? (0 или 1), по умолчанию – 1 |
| site_group_id | Нет | ID группы, в которую будет добавлен новый проект |
| check_day | Нет |
Если проверка еженедельная (check_weekly), то в этом параметре можно задать день недели.(от 1 – понедельник до 7 – воскресенье)
Если проверка check_monthly, то в параметре день месяца (1 – 31) |
| is_active | Нет | Статус проекта: 1 – активен, 0 – отложен |
Результат
В случае успеха сервер вернет HTTP код 201 и ID добавленного проекта в аккаунт.
| Имя | Обязательный | Описание |
| site_id | Да | ID проекта, добавленного в аккаунт |
Пример ответа
{
“site_id”: 507052
}
Изменение настроек проекта
Метод позволяет изменить/обновить настройки проекта.
Формат запроса
PUT https://api4.seranking.com/sites/{site_id}
{
“title”:”new site title”
}
Параметры запроса
| Имя | Описание |
| url | URL сайта |
| title | Название сайта |
| depth | Глубина сбора позиций (100, 200), по умолчанию – 100. |
| subdomain_match | Учитывать сабдомены в выдаче? (0 или 1), по умолчанию – 0 |
| exact_url | Точный URL? (0 или 1), по умолчанию – 0 |
| check_freq | Периодичность проверки позиций (‘check_daily’, ‘check_1in3’, ‘check_weekly’, ‘check_monthly’, ‘manual’), по умолчанию – check_daily |
| site_group_id | ID группы, в которую будет добавлен новый проект |
| check_day | Если проверка еженедельная (check_weekly), то в этом параметре можно задать день недели. (от 1 – понедельник до 7 – воскресенье). Если проверка check_monthly, то в параметре день месяца (1 – 31) |
| is_active | 1, 0 |
Результат
В случае успеха сервер вернет HTTP 200.
Удаление проекта
Метод позволяет удалить проект из аккаунта пользователя.
Формат запроса
DELETE https://api4.seranking.com/sites/{site_id}
Результат
В случае успеха сервер вернет HTTP 204.
Удаление ключевых слов
Метод позволяет удалить ключевые слова из проекта.
Формат запроса
DELETE https://api4.seranking.com/sites/{site_id}/keywords?keywords_ids[]=1&keywords_ids[]=2&keywords_ids[]=3
Query-параметры запроса
| Имя | Обязательный | Описание |
| keywords_ids | Да | Массив ID удаляемых ключевых слов |
Результат
В случае успеха сервер вернет HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | No ids in request |
Ручная установка позиции
Метод позволяет установить позиции для ключевых слов проекта.
Формат запроса
https://api4.seranking.com/sites/{site_id}/position/
{
“keyword_id”: 1,
“date”: “2018-01-01”,
“position”:100,
“site_engine_id”: 1
}
Параметры запроса
| Имя | Обязательный | Тип | Описание |
| keyword_id | Да | Уникальный идентификатор ключевого слова (см. GET https://api4.seranking.com/sites/{site_id}/keywords) | |
| date | Да | yyyy-mm-dd | Дата, на которую надо установить позиции |
| site_engine_is | Да | Уникальный идентификатор поисковой системы в проекте (см GET https://api4.seranking.com/sites/{site_id}/search-engines) | |
| position | Да | Позиция, от 0 до 200, 0 считается как “не найдено” |
Результат
В случае успеха сервер вернет HTTP 200.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Invalid date |
| 400 | Invalid keyword_id |
| 400 | Unknown site_engine_id |
Запуск проверки позиций
Метод позволяет запустить проверку позиций для выбранных ключевых слов либо для всего проекта.
Формат запроса
POST https://api4.seranking.com/sites/{site_id}/recheck/
{
“keywords”:[
{
“site_engine_id”:1,
“keyword_id”:2
}
]
}
Параметры
| Имя | Обязательный | Описание |
| site_engine_id | Нет | Уникальный идентификатор поисковой системы проекта. Если этот параметр присутствует в API-запросе, то будет запущена проверка позиций только для этой поисковой системы. |
| keywords | Да |
Массив отдельных ключевых слов, для которых нужно запустить проверку позиций. Если массив пустой – выполняется проверка для всех ключевых слов. Для каждого ключевого слова указывается пара значений: site_engine_id (уникальный идентификатор поисковой системы проекта) и keyword_id (уникальный идентификатор ключевого слова).
Если этот параметр присутствует в API-запросе, то параметр site_engine_id игнорируется. |
Результат
В случае успеха сервер возвращает HTTP 200 и количество ключевых слов, для которых была запущена проверка позиций.
| Имя | Описание |
| total | Количество ключевых слов, для которых запущена проверка позиций |
Пример ответа
{
“total”: 5
}
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Unknown site_engine_id |