Звіти

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

Кінцева точка API:

GET 
https://seoshop.com.ua/api/v1/reports

Приклад запиту: 

curl --location --request GET 'https://seoshop.com.ua/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. За замовчуванням: 50.
Показати

Кінцева точка API:

GET 
https://seoshop.com.ua/api/v1/reports/{id}

Приклад запиту: 

curl --location --request GET 'https://seoshop.com.ua/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Зберегти

Кінцева точка API:

POST 
https://seoshop.com.ua/api/v1/reports

Приклад запиту: 

curl --location --request POST 'https://seoshop.com.ua/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://seoshop.com.ua/api/v1/reports/{id}

Приклад запиту: 

curl --location --request PUT 'https://seoshop.com.ua/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://seoshop.com.ua/api/v1/reports/{id}

Приклад запиту: 

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