API Description

API для бэклинков

Список бэклинков

Описание

Метод позволяет получить список бэклинков сайта.

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

Title of the code block

Copy

 GET /backlinks/{site_id}?limit=100&offset=100

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

Имя	Обязательный	Описание
limit	Нет	Количество ссылок. Максимум 1000
offset	Нет	Смещение

Результат

В случае успеха сервер возвращает список бэклинков сайта.

Пример

Title of the code block

Copy

[

{

"anchor": "SE Ranking",

"category": "",

"charge_period": null,

"charge_start": null,

"date_added": "2018-06-11",

"date_lost": "2021-10-10",

"date_placement": "2018-10-11",

"domain": "highpoweredseo.com",

"duration": "",

"fb_likes": "2",

"from_domainid": "4630",

"from_url": "https://highpoweredseo.com/how-to-become-a-better",

"gin_index": "11",

"gin_index_check_date": "2018-10-05",

"http_status": "1",

"id": "53",

"is_blocked_meta": "1",

"is_blocked_robotstxt": "1",

"is_disavow": "0",

"is_forced_status": "0",

"is_image": "1",

"is_link_not_found": "1",

"is_nofollow": "1",

"is_redir": "1",

"is_sponsored": "0",

"last_crawler_visit": "2018-10-05",

"link_manager": "",

"link_type": "",

"notes": "ghjg",

"num_links": 10,

"price": null,

"source": null,

"src_domain_country": "USA",

"src_domain_inlink_rank": null,

"src_domain_ip": "184.168.221.40",

"src_domain_mozda_date": null,

"src_domain_region_id": null,

"title": "Title",

"to_url": "https://tourl.ru/",

"total_ext_links": "2",

"ugc": null,

"yin_index": "12",

"yin_index_check_date": "2018-10-05"

},

...

]

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

Имя	Описание
anchor	Анкор обратной ссылки
id	ID ссылки
category	Целевая категория обратной ссылки
charge_period	Период оплаты стоимости (onetime – единоразово, monthly – за месяц, quarterly – за квартал, 6months – за полгода, year – за год)
charge_start	Дата начала оплаты
date_added	Дата добавления ссылки
date_lost	Дата потери ссылки
date_placement	Дата размещения обратной ссылки
domain	Домен страницы, ссылающейся на ваш сайт
duration	Продолжительность размещения обратной ссылки согласно договоренностям с донором
fb_likes	Сколько человек поделились данной страницей в Facebook
from_domainid	ID домена ссылки
from_url	Адрес страницы, ссылающейся на ваш сайт
gin_index	Проиндексирована ли страница с обратной ссылкой в Google
gin_index_check_date	Дата проверки
http_status	Http-статус страницы с ссылкой
is_blocked_meta	Страница блокирована через meta-заголовок
is_forced_status	Статус был изменен вручную
is_blocked_robotstxt	Блокирована через robots.txt
is_disavow	Ссылка является disavow
is_forced_status	Статус был изменен вручную
is_image	Ссылка на изображении
is_link_not_found	Обратная ссылка на странице не найдена
is_nofollow	Ссылка закрыта от индексации
is_redir	Страница перенаправляет на другую страницу
is_sponsored	Ссылка является спонсорской
last_crawler_visit	Дата последней проверки
link_manager	Ответственное лицо
link_type	Тип анкора обратной ссылки
notes	Примечание
num_links	Кол-во ссылок
price	Цена размещения ссылки
source	Источник
src_domain_country	Страна
src_domain_inlink_rank	Ранк домена
src_domain_ip	Ссылающиеся IP адреса
src_domain_mozda_date	Дата проверки
src_domain_region_id	Id региона


title	Title страницы
to_url	Ссылается на страницу
total_ext_links	Число внешних ссылок, найденных на странице с обратной ссылкой
ugc	UGC (пользовательский контент)

Error

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)

Добавление бэклинка

Title of the code block

Copy

POST /backlinks/{site_id}

{

"url": "https://backlink.test/",

"price": 1,

"charge_period": "onetime",

"charge_start": "2018-01-01"

}

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

Имя	Обязательный	Описание
url	Да	Ссылка
price	Нет	Стоимость
currency	Нет	Код валюты ISO 4217 (USD, CAD, AUD, etc.)
charge_period	Нет	Оплата стоимости (onetime – единоразово, monthly – за месяц)
charge_start	Нет	Оплата с даты

Результат

В случае успеха сервер возвращает id добавленной ссылки.

Пример

Title of the code block

Copy

{

"id": 1

}

Ошибки

HTTP-код	Сообщение об ошибке
400	Invalid URL
400	Backlinks limit exceeded
400	Backlink already exist
403	Access denied (wrong site_id)

Импорт списка бэклинков

Метод позволяет импортировать список бэклинков сайта.

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

Title of the code block

Copy

 POST /backlinks/{site_id}/list

{

    "group_id": 1,

    "price": 100,

    "currency": "USD",

    "manager": "manager",

    "charge_period": "onetime",

    "charge_start": "2021-10-10",

    "list": [

        "https://google.com",

        "https://google.com"

    ]

}

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

Имя	Обязательный	Описание
site_id	Да	id сайта
list	Да	Массив бэклинков
price	Нет	Стоимость
currency	Нет	Код валюты ISO 4217 (USD, CAD, AUD, etc.)
charge_period	Нет	Период оплаты стоимости (onetime – единоразово, monthly – за месяц, quarterly – за квартал, 6months – за полгода, year – за год)
charge_start	Нет	Оплата с даты, формат (Y-m-d)
group_id	Нет	id группы бэклинков
manager	Нет	Менеджер

Результат

В случае успеха сервер возвращает кол-во добавленных бэклинков, кол-во дубликатов и общее кол-во бэклинков.

Пример

Title of the code block

Copy

 {

    "added": 2,

    "duplicates": 0,

    "total": 2

}

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

Имя	Описание
added	Кол-во добавленных бэклинков
duplicates	Кол-во дубликатов бэклинков
total	Общее кол-во бэклинков

Error

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)

Обновление настроек запуска импорта бэклинков

Метод позволяет обновить настройки автоматического импорта бэклинков из Google Search Console.

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

Title of the code block

Copy

 PUT /backlinks/{site_id}/settings

{

    "gsc_autoimport": true,

}

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

Имя	Обязательный	Описание
site_id	Да	id сайта
gsc_autoimport	Да	true или false, включить или отключить автоимпорт из GSC

Результат

В случае успеха сервер возвращает HTTP 204.

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)

Запуск импорта бэклинков из Google Search Console

Метод позволяет запустить импорт бэклинков из Google Search Console.

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

Title of the code block

Copy

POST /backlinks/{site_id}/import-gsc

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

Имя	Обязательный	Описание
site_id	Да	id сайта

Результат

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

Пример

Title of the code block

Copy

{

    "status": "queued",

    "token": "1c84d0375d44725521647919c17f1cb9"

}

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

Имя	Описание
status	Статус задачи импорта
token	Токен задачи импорта

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)

Получение статуса импорта бэклинков из Google Search Console

Метод позволяет получить статус импорта бэклинков из Google Search Console.

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

Title of the code block

Copy

GET /backlinks/{site_id}/import-status

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

Имя	Обязательный	Описание
site_id	Да	id сайта
token	Да	token задачи импорта, полученный в методе запуска импорта бэклинков

Результат

В случае успеха сервер возвращает статус задачи импорта и время в формате timestamp.

Пример

Title of the code block

Copy

{

    "time": 1635417036150,

    "status": "queued"

}

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

Имя	Описание
status	Статус задачи импорта
time	Время в формате timestamp

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)

Удаление списка бэклинков

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

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

Title of the code block

Copy

POST /backlinks/{site_id}/delete

{

    "backlink_ids": [

        1,

        2,

        3

    ]

}

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

Имя	Обязательный	Описание
site_id	Да	id сайта
backlink_ids	Да	Массив ids бэклинков

Результат

В случае успеха сервер возвращает HTTP 204

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)
400	Invalid ids

Запуск проверки индекса/статуса бэклинков

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

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

Title of the code block

Copy

POST /backlinks/{site_id}/recheck

{

    "backlink_ids": [

        1,

        2

    ],

    "recheck_type":"index"

}

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

Имя	Обязательный	Описание
site_id	Да	id сайта
backlink_ids	Да	Массив ids бэклинков
recheck_type	Нет	Тип проверки, возможные значения: status, index. Если не передать параметр, по умолчанию будет использоваться recheck_type=status

Результат

В случае успеха сервер возвращает HTTP 204.

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)
400	Invalid ids

Статистика по бэклинкам

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

Title of the code block

Copy

 GET /backlinks/{site_id}/stat

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

Имя	Обязательный	Описание
site_id	Да	ID сайта

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

Title of the code block

Copy

{

"total": 9,

"anchors": 1,

"ip": 8,

"domains": 9,

"dofollow": 0,

"nofollow": 1,

"limit": 988

}

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

Имя	Описание
total	Всего ссылок
anchors	Количество уникальных анкоров
ip	Количество уникальных IP адресов
domains	Количество уникальных доменов
dofollow	Количество ссылок dofollow
nofollow	Количество ссылок nofollow
limit	Лимит на добавление ссылок. Доступно для добавления сегодня

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)

Список disavow-ссылок

Метод позволяет получить список и количество disavow-ссылок для сайта.

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

Title of the code block

Copy

GET /backlink-disavow/{site_id}?limit=100&offset=0

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

Имя	Обязательный	Описание
site_id	Да	id сайта
limit	Нет	Кол-во disavow ссылок
offset	Нет	Смещение

Результат

В случае успеха сервер возвращает список и количество disavow-ссылок для сайта.

Пример

Title of the code block

Copy

{

    "total_disavow_links": 2,

    "disavow_links": [

        {

            "id": 4,

            "url": "https://google.com",

            "type": "url",

            "exported": 0,

            "domain_inlink_rank": 100

        }

    ]

}

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

Имя	Описание
total_disavow_links	Общее кол-во disavow-ссылок
disavow_links	Массив disavow-ссылок
id	id disavow-ссылки
url	url disavow-ссылки
type	Тип ссылки
exported	Экспортирована ли ссылка

domain_inlink_rank	Ранк домена

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)

Добавление списка disavow-ссылок

Метод позволяет добавить список disavow-ссылок для сайта.

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

Title of the code block

Copy

POST /backlink-disavow/{site_id}

{

    "list": [

        "https://google.com"    ]

}

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

Имя	Обязательный	Описание
site_id	Да	id сайта
list	Да	Массив ссылок

Результат

В случае успеха сервер возвращает кол-во добавленных disavow-ссылок.

Пример

Title of the code block

Copy

{

    "added": 2

}

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

Имя	Описание
added	Кол-во добавленных disavow-ссылок

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)
400	Invalid list

Удаление disavow-ссылки

Метод позволяет удалить disavow-ссылку из списка disavow-ссылок для сайта.

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

Title of the code block

Copy

DELETE /backlink-disavow/{site_id}?id={disavow_link_id}

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

Имя	Обязательный	Описание
site_id	Да	id сайта
disavow_link_id	Да	id disavow-ссылки

Результат

В случае успеха сервер возвращает HTTP 204.

Ошибки

HTTP-код	Сообщение об ошибке
403	Access denied (wrong site_id)
400	Invalid disawov link id
400	Disawov link does not exist