nofollow
BLACKFRIDAY2018

-30% скидки на любую оплату
подробнее

Черная пятница в SE Ranking: 30% скидки на любую оплату. подробнее

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

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

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

Запрос

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 Название сайта
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 Гостевая ссылка для просмотра статистики сайта без авторизации

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

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

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

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
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

Результат

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

Имя Описание
id Уникальный идентификатор запроса
name Ключевое слово
group_id ID группы запросов
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 Средняя позиция за предыдущую дату снятия позиций (вчера)
total_up Сколько позиций поднялось в выдаче
total_down Сколько позиций опустилось в выдаче
process Текущий процент обработки позиций сайта
top5 Запросов в ТОП 5
top10 Запросов в ТОП 10
top30 Запросов в ТОП 30
visibility Прогноз трафика
visibility_percent Видимость в %
da Moz Domain Authority
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

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 Название бизнеса. Для выдачи Google Maps. Только для Google

Результат

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

Имя Описание
id Уникальный идентификатор запроса
positions Массив с элементами
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

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

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

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

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-код Сообщение об ошибке
400 No 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_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

Ручная установка позиции

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

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

PUT 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_id Да Уникальный идентификатор поисковой системы в проекте (см 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 игнорируется.

Результат

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

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

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

{
    "total": 5
}

Ошибки

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