nofollow

Управление проектами (сайтами)

Список сайтов пользователя

Метод позволяет получить список всех проектов пользователя.

Запрос

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»
}
]

Параметры

ИмяОписание
idУникальный идентификатор сайта (ID)
titleНазвание сайта
nameURL сайта
group_idID группы сайтов
is_activeСтатус сайта 1 — активный, 0 — отложенный
exact_url1 — Позиции будут проверятся только для указанного URL без учета подпапок и поддоменов.
subdomain_match1 — Учитывать сабдомены в выдаче
depthГлубина сбора позиций
check_freqПериодичность проверок
check_dayЕсли проверка еженедельная (check_weekly), то в этом параметре день недели. (от 1-понедельник до 7 — воскресенье). Если проверка ежемесячная (check_monthly), то в параметре день месяца. (1-31)
guest_linkГостевая ссылка для просмотра статистики сайта без авторизации

Список поисковых систем сайта

Метод позволяет получить список поисковых систем проекта.

Формат запроса

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_idID поисковой системы (см. GET /system/search-engines)
region_idID региона. Только для 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-кодСообщение об ошибке
400Invalid keyword_id
400Invalid date
400No ids in request
404Unknown search_engine_id
404Unknown 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-кодСообщение об ошибке
404Unknown 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

Результат

В случае успеха сервер вернет массив со списком ключевых слов проекта со статистикой по каждому из них.

ИмяОписание
idУникальный идентификатор запроса
nameКлючевое слово
group_idID группы запросов
linkЦелевой URL
first_check_dateДата первой проверки запроса

Пример ответа

[
{
«id»: «1»,
«name»: «key1»,
«group_id»: «2»,
«link»: null,
«first_check_date»: «2015-02-17»
},
{
«id»: «2»,
«name»: «key2»,
«group_id»: «2»,
«link»: «http://mysite.com/»,
«first_check_date»: «2016-02-04»
},
…
]

Сводная статистика

Метод позволяет получить сводную статистику по проекту.

Формат запроса

GET https://api4.seranking.com/sites/{site_id}/stat

Результат

ИмяОписание
site_idУникальный идентификатор сайта (ID)
today_avgСредняя позиция за последнюю дату снятия позиций (сегодня)
yesterday_avgСредняя позиция за предыдущую дату снятия позиций (вчера)
today_upСколько позиций поднялось в выдаче
today_downСколько позиций опустилось в выдаче
processТекущий процент обработки позиций сайта
top5Запросов в ТОП 5
top10Запросов в ТОП 10
top30Запросов в ТОП 30
visibilityПрогноз трафика
visibility_percentВидимость в %
daMoz Domain Authority
index_yandexКоличество страниц в индексе Яндекс
yandex_xYandex_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

Query-параметры

Все параметры не обязательны.

ИмяТипОписание
date_fromyyyy-mm-ddДата начала периода (по умолчанию – сегодня минус неделя)
date_toyyyy-mm-ddДата конца периода (по умолчанию – сегодня)
site_engine_id ID поисковой системы. Если не указано, вернёт данные по всем поисковым системам
in_top Фильтр по позиции. Напр. in_top=10 вернёт данные только о запросах, входящих в ТОП 10 на момент последней проверки в выбранном периоде.
with_landing_pages Информация url страницы в поисковой выдаче
with_serp_features Название бизнеса. Для выдачи Google Maps. Только для Google

Результат

В случае успеха сервер вернет массив из всех (или указанной) поисковых систем проекта, содержащий статистику по ключевым словам за указанный период.

ИмяОписание
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,
«results»: 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-кодСообщение об ошибке
404Invalid site_engine_id

Исторические даты

Метод возвращает список дат, необходимых для постройки графика исторических позиций. Даты соответствуют следующему списку: сегодня, вчера, 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»,
}

Добавление запросов в проект

Метод позволяет добавлять новые ключевые слова в проект.

Формат запроса

POST https://api4.seranking.com/sites/{site_id}/keywords
[{
«keyword»:»text»,
«group_id»:1,
«target_url»: «http://site.com/»,
«is_strict»: 0,
«comment»:»text»
}]

Параметры в запросе

ИмяОбязательныйОписание
keywordДаКлючевое слово (запрос)
group_idНетID группы ключевых слов (если параметр не указан, будет использована группа по умолчанию)
target_URLНетЦелевая ссылка
is_strictНетПроверять позиции только для указанных целевых ссылок (0 или 1, по умолчанию – 0)
commentНетКомментарий

Результат

В случае успеха сервер вернет массив с количеством добавленных ключевых слов и их ID в проекте.

ИмяОбязательныйОписание
addedДаКоличество успешно добавленных запросов в проект
idsНетМассив ID добавленных запросов

Пример ответа

{
«added»: 3,
«ids»: [
123,
456,
789
]
}

Ошибки

HTTP-кодСообщение об ошибке
404No keywords specified

Добавление проекта

Метод позволяет добавить новый проект в аккаунт пользователя.

Формат запроса

POST https://api4.seranking.com/sites
{
«url»:»http://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_groupe_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»
}

Параметры запроса

ИмяОписание
urlURL сайта
titleНазвание сайта
depthГлубина сбора позиций (100, 200), по умолчанию – 100
subdomain_matchУчитывать сабдомены в выдаче? (0 или 1), по умолчанию – 0
exact_url1 — Позиции будут проверятся только для указанного URL без учета подпапок и поддоменов.
check_freqПериодичность проверки позиций (‘check_daily’, ‘check_1in3’, ‘check_weekly’, ‘check_monthly’, ‘manual’), по умолчанию – check_daily
site_group_idID группы, в которую будет добавлен новый проект
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-кодСообщение об ошибке
400No 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-кодСообщение об ошибке
400Invalid date
400Invalid keyword_id
400Unknown 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 игнорируется.

Результат

В случае успеха сервер вернет массив, содержащий количество ключевых слов, для которых была запущена проверка позиций.

ИмяОбязательныйОписание
totalДаКоличество ключевых слов, для которых запущена проверка позиций

Пример ответа

{
«total»: 5
}

Ошибки

HTTP-кодСообщение об ошибке
400Unknown site_engine_id