Уебсайтове

Бележки
Експертно ниво
API ключът се изпраща като Bearer токен в заглавката Authorization на заявката. Вземете вашия API ключ.
Списък

Адрес на API:

GET
https://www.analytics.nmax.dev/api/v1/websites

Пример на заявка:

curl --location --request GET 'https://www.analytics.nmax.dev/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметър
Тип
Описание
search
по избор string
Текстът за търсене.
search_by
по избор string
Търсене по. Възможни стойности са: domain за Домейн. По подразбиране: domain.
sort_by
по избор string
Сортирай по. Възможни стойности са: id за Дата на създаване, domain за Домейн. По подразбиране: id.
sort
по избор string
Сортиране. Възможни стойности са: desc за Низходящ ред, asc за Възходящ ред. По подразбиране: desc.
per_page
по избор int
Резултати на страница. Възможни стойности са: 10, 25, 50, 100. По подразбиране: 10.
Показване

Адрес на API:

GET
https://www.analytics.nmax.dev/api/v1/websites/{id}

Пример на заявка:

curl --location --request GET 'https://www.analytics.nmax.dev/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Създаване

Адрес на API:

POST
https://www.analytics.nmax.dev/api/v1/websites

Пример на заявка:

curl --location --request POST 'https://www.analytics.nmax.dev/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 за Парола. По подразбиране: 1.
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://www.analytics.nmax.dev/api/v1/websites/{id}

Пример на заявка:

curl --location --request PUT 'https://www.analytics.nmax.dev/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 адреси от проследяването. Едно на ред..
Изтриване

Адрес на API:

DELETE
https://www.analytics.nmax.dev/api/v1/websites/{id}

Пример на заявка:

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