Отчеты

Примечания
Expert level
Ключ API должен быть отправлен как токен носителя в заголовке авторизации запроса. Получите свой API-ключ.
Список

конечная точка API:

GET 
https://www.rank-seo.ru/api/v1/reports

Пример запроса: 

curl --location --request GET 'https://www.rank-seo.ru/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
необязательный string
Search query.
search_by
необязательный string
Поиск по. Возможные значения: url для URL-адрес (https://имя_домена). По умолчанию: url.
project
необязательный string
Project name
result
необязательный string
The report result. Возможные значения: good для Хороший, decent для Приличный, bad для Плохой.
sort_by
необязательный string
Сортировать по. Возможные значения: id для Дата создания, generated_at для Дата создания, url для URL-адрес (https://имя_домена), score для Score. По умолчанию: id.
sort
необязательный string
Сортировать. Возможные значения: desc для По убыванию, asc для восходящий. По умолчанию: desc.
per_page
необязательный integer
Результаты на странице. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Показывать

конечная точка API:

GET 
https://www.rank-seo.ru/api/v1/reports/{id}

Пример запроса: 

curl --location --request GET 'https://www.rank-seo.ru/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Магазин

конечная точка API:

POST 
https://www.rank-seo.ru/api/v1/reports

Пример запроса: 

curl --location --request POST 'https://www.rank-seo.ru/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Параметр
Тип
Описание
url
необходимый string
The webpage's URL.
privacy
необязательный integer
Report page privacy. Возможные значения: 0 для Общественный, 1 для Частный, 2 для Пароль. По умолчанию: 0.
password
необязательный string
The password for the report page. Only works with privacy field set to 2.
Обновлять

конечная точка API:

PUT PATCH 
https://www.rank-seo.ru/api/v1/reports/{id}

Пример запроса: 

curl --location --request PUT 'https://www.rank-seo.ru/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
privacy
необязательный integer
Report page privacy. Возможные значения: 0 для Общественный, 1 для Частный, 2 для Пароль.
password
необязательный string
The password for the report page. Only works with privacy field set to 2.
update
необязательный integer
Обновлять. Возможные значения: 0 для Нет, 1 для Да. По умолчанию: 0.
Удалить

конечная точка API:

DELETE 
https://www.rank-seo.ru/api/v1/reports/{id}

Пример запроса: 

curl --location --request DELETE 'https://www.rank-seo.ru/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'