Сайты

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

Адрес метода API:

GET 
https://www.webmetr.pro/api/v1/websites

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

curl --location --request GET 'https://www.webmetr.pro/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://www.webmetr.pro/api/v1/websites/{id}

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

curl --location --request GET 'https://www.webmetr.pro/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Создание

Адрес метода API:

POST 
https://www.webmetr.pro/api/v1/websites

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

curl --location --request POST 'https://www.webmetr.pro/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
Пароль. Работает только при значении 2 в поле privacy.
email
необязательно integer
Периодические отчёты по электронной почте. Допустимые значения: 0 для Отключено, 1 для Включено. По умолчанию: 0.
exclude_bots
необязательно integer
Не учитывать известных роботов в статистике. Допустимые значения: 0 для Отключено, 1 для Включено. По умолчанию: 1.
exclude_params
необязательно string
Исключить параметры адреса из статистики. Каждое значение с новой строки.
exclude_ips
необязательно string
Не учитывать посещения с указанных IP-адресов. Каждое значение с новой строки..
Обновить запись

Адрес метода API:

PUT PATCH 
https://www.webmetr.pro/api/v1/websites/{id}

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

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

Адрес метода API:

DELETE 
https://www.webmetr.pro/api/v1/websites/{id}

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

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