Уебсайтове

Бележки
Експертно ниво
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}'