Вебсайты

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

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

GET 
https://upstat.link/api/v1/websites

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

curl --location --request GET 'https://upstat.link/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
необязательно string
Запрос поиска.
search_by
необязательно string
Искать по. Возможные значения: domain для Домен. По умолчанию: domain.
favorite
необязательно boolean
Фильтровать по избранным.
sort_by
необязательно string
Сортировать по. Возможные значения: id для Дата создания, domain для Домен. По умолчанию: id.
sort
необязательно string
Сортировать. Возможные значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.
per_page
необязательно integer
Результатов на страницу. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Показать

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

GET 
https://upstat.link/api/v1/websites/{id}

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

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

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

POST 
https://upstat.link/api/v1/websites

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

curl --location --request POST 'https://upstat.link/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Параметр
Тип
Описание
domain
обязательно string
Имя домена.
privacy
необязательно integer
Конфиденциальность страницы статистики. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль. По умолчанию: 0.
password
необязательно string
Пароль для страницы статистики. Работает только с privacy установленным на 2.
email
необязательно integer
Периодические отчёты по электронной почте. Возможные значения: 0 для Отключено, 1 для Включено. По умолчанию: 0.
exclude_bots
необязательно integer
Исключить общих ботов из отслеживания. Возможные значения: 0 для Отключено, 1 для Включено. По умолчанию: 1.
exclude_params
необязательно string
Exclude URL query parameters from being tracked. Один на строку..
exclude_ips
необязательно string
Исключить IP-адреса из отслеживания. Один на строку..
Обновить

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

PUT PATCH 
https://upstat.link/api/v1/websites/{id}

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

curl --location --request PUT 'https://upstat.link/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
privacy
необязательно integer
Конфиденциальность страницы статистики. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль.
password
необязательно string
Пароль для страницы статистики. Работает только с privacy установленным на 2.
email
необязательно integer
Периодические отчёты по электронной почте. Возможные значения: 0 для Отключено, 1 для Включено.
exclude_bots
необязательно integer
Исключить общих ботов из отслеживания. Возможные значения: 0 для Отключено, 1 для Включено.
exclude_params
необязательно string
Exclude URL query parameters from being tracked. Один на строку..
exclude_ips
необязательно string
Исключить IP-адреса из отслеживания. Один на строку..
favorite
необязательно boolean
Является ли сайт избранным или нет.
Удалить

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

DELETE 
https://upstat.link/api/v1/websites/{id}

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

curl --location --request DELETE 'https://upstat.link/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'