Отчеты

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

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

GET 
https://seo.itbizlab.ru/api/v1/reports

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

curl --location --request GET 'https://seo.itbizlab.ru/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
оптимально string
Поисковый запрос.
search_by
оптимально string
Искать по. Possible values are: url for URL-адрес. Defaults to: url.
project
оптимально string
Имя проекта.
result
оптимально string
The report result. Possible values are: good for Хороший, decent for Приличный, bad for Плохо.
sort_by
оптимально string
Сортировать по. Possible values are: id for Дата создания, generated_at for Дата создания, url for URL-адрес, result for Результат. Defaults to: id.
sort
оптимально string
Сортировка. Possible values are: desc for По убыванию, asc for По возрастанию. Defaults to: desc.
per_page
оптимально int
Результатов на страницу. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Показать

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

GET 
https://seo.itbizlab.ru/api/v1/reports/{id}

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

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

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

POST 
https://seo.itbizlab.ru/api/v1/reports

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

curl --location --request POST 'https://seo.itbizlab.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. Possible values are: 0 for Публичный, 1 for Приватный, 2 for Пароль. Defaults to: 1.
password
оптимально string
The password for the report page. Only works with privacy set to 2.
Обновить

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

PUT PATCH 
https://seo.itbizlab.ru/api/v1/reports/{id}

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

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

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

DELETE 
https://seo.itbizlab.ru/api/v1/reports/{id}

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

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