Отчеты

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

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

GET 
https://api.dreaper.ru/api/v1/reports

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

curl --location --request GET 'https://api.dreaper.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, result для Результат. Значение по умолчанию: id.
sort
опционально string
Сортировка. Возможные значения: desc для По убыванию, asc для По возрастанию. Значение по умолчанию: desc.
per_page
опционально integer
Результатов на страницу. Возможные значения: 10, 25, 50, 100. Значение по умолчанию: 10.
Показать

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

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

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

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

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

POST 
https://api.dreaper.ru/api/v1/reports

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

curl --location --request POST 'https://api.dreaper.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 set to 2.
Обновить

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

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

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

curl --location --request PUT 'https://api.dreaper.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 set to 2.
results
опционально integer
Update the report results. Возможные значения: 0 для Нет, 1 для Да. Значение по умолчанию: 0.
Удалить

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

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

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

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