وب‌سایت‌ها

یادداشت‌ها
سطح کارشناسی
کلید API باید به عنوان یک توکن Bearer در هدر Authorization درخواست ارسال شود. کلید API خود را دریافت کنید.
لیست

نقطه پایانی API:

GET 
https://analytics.tik4.com/api/v1/websites

مثال درخواست: 

curl --location --request GET 'https://analytics.tik4.com/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://analytics.tik4.com/api/v1/websites/{id}

مثال درخواست: 

curl --location --request GET 'https://analytics.tik4.com/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
ذخیره

نقطه پایانی API:

POST 
https://analytics.tik4.com/api/v1/websites

مثال درخواست: 

curl --location --request POST 'https://analytics.tik4.com/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://analytics.tik4.com/api/v1/websites/{id}

مثال درخواست: 

curl --location --request PUT 'https://analytics.tik4.com/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://analytics.tik4.com/api/v1/websites/{id}

مثال درخواست: 

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