Отчеты

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

API endpoint:

GET 
https://ogs-tools.ru/api/v1/reports

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

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

API endpoint:

GET 
https://ogs-tools.ru/api/v1/reports/{id}

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

curl --location --request GET 'https://ogs-tools.ru/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Сохранить

API endpoint:

POST 
https://ogs-tools.ru/api/v1/reports

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

curl --location --request POST 'https://ogs-tools.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. Работает только с полем privacy, установленным в значение 2.
Обновить

API endpoint:

PUT PATCH 
https://ogs-tools.ru/api/v1/reports/{id}

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

curl --location --request PUT 'https://ogs-tools.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. Работает только с полем privacy, установленным в значение 2.
update
необязательно integer
Обновить. Возможные значения: 0 для Нет, 1 для Да. По умолчанию: 0.
Удалить

API endpoint:

DELETE 
https://ogs-tools.ru/api/v1/reports/{id}

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

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