Сайты

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

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

GET 
https://metrics.fantasis.co/api/v1/websites

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

curl --location --request GET 'https://metrics.fantasis.co/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. По умолчанию используется значение: 25.
Показать

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

GET 
https://metrics.fantasis.co/api/v1/websites/{id}

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

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

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

POST 
https://metrics.fantasis.co/api/v1/websites

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

curl --location --request POST 'https://metrics.fantasis.co/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 для Enabled. По умолчанию используется значение: 0.
exclude_bots
необязательно integer
Исключить из отслеживания обычных ботов Возможные значения: 0 для Отключено, 1 для Enabled. По умолчанию используется значение: 1.
exclude_params
необязательно string
Exclude URL query parameters from being tracked. По одному на строку.
exclude_ips
необязательно string
Исключите отслеживание IP По одному на строку..
Обновить

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

PUT PATCH 
https://metrics.fantasis.co/api/v1/websites/{id}

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

curl --location --request PUT 'https://metrics.fantasis.co/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 для Enabled.
exclude_bots
необязательно integer
Исключить из отслеживания обычных ботов Возможные значения: 0 для Отключено, 1 для Enabled.
exclude_params
необязательно string
Exclude URL query parameters from being tracked. По одному на строку.
exclude_ips
необязательно string
Исключите отслеживание IP По одному на строку..
favorite
необязательно boolean
Избранное.
Удалить

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

DELETE 
https://metrics.fantasis.co/api/v1/websites/{id}

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

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