Запросы — сервис аналитики маркетплейсов

Примечание

Экспертный уровень

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

API работает с отчётами, проектами и данными аккаунта. Запуск SEO-инструментов через API недоступен.

Доступно на тарифах с API. Без него сервер отвечает 403. Лимиты: 60 запросов в минуту, создание и обновление отчётов — 10 в минуту.

Список

API endpoint:

GET

https://itseo.pro/api/v1/reports

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

curl --location --request GET 'https://itseo.pro/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

search

необязательно string

Поисковый запрос.

search_by

необязательно string

Искать по. Возможные значения: url для URL. По умолчанию: url.

project

необязательно string

Название проекта.

result

необязательно string

Результат отчёта. Возможные значения: good для Отлично, decent для Хорошо, bad для Плохо.

sort_by

необязательно string

Сортировать по. Возможные значения: id для Дата создания, generated_at для Дата генерации, url для URL, result для Результат. По умолчанию: id.

sort

необязательно string

Сортировка. Возможные значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.

per_page

необязательно int

Результатов на странице. Возможные значения: 10, 25, 50, 100. По умолчанию: 100.

Показать

API endpoint:

GET

https://itseo.pro/api/v1/reports/{id}

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

curl --location --request GET 'https://itseo.pro/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Создать

API endpoint:

POST

https://itseo.pro/api/v1/reports

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

curl --location --request POST 'https://itseo.pro/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Параметр

Тип

Описание

url

обязательно string

URL веб-страницы.

privacy

необязательно integer

Приватность страницы отчёта. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль. По умолчанию: 1.

password

необязательно string

Пароль для страницы отчёта. Работает только когда privacy установлено в 2.

Обновить

API endpoint:

PUT PATCH

https://itseo.pro/api/v1/reports/{id}

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

curl --location --request PUT 'https://itseo.pro/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

privacy

необязательно integer

Приватность страницы отчёта. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль.

password

необязательно string

Пароль для страницы отчёта. Работает только когда privacy установлено в 2.

results

необязательно integer

Обновить результаты отчёта. Возможные значения: 0 для Нет, 1 для Да. По умолчанию: 0.

Удалить

API endpoint:

DELETE

https://itseo.pro/api/v1/reports/{id}

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

curl --location --request DELETE 'https://itseo.pro/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'

Отчеты