وب سایت ها

یادداشت ها

سطح پیشرفته

جهت اتصال به endpoint در سیستم API، می بایست از کلید آن استفاده کنید. کلید API خود را دریافت کنید.

لیست

endpoint در API:

GET

https://statsfa.com/api/v1/websites

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

curl --location --request GET 'https://statsfa.com/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

پارامتر

نوع

توضیحات

search

اختیاری string

کوئری جستجو.

search_by

اختیاری string

جستجو با. مقادیر قابل استفاده: domain برای دامنه. Defaults to: domain.

favorite

اختیاری boolean

Filter by favorite.

sort_by

اختیاری string

مرتب‌سازی بر اساس. مقادیر قابل استفاده: id برای تاریخ ایجاد, domain برای دامنه. Defaults to: id.

sort

اختیاری string

مرتب سازی. مقادیر قابل استفاده: desc برای نزولی, asc برای سعودی. Defaults to: desc.

per_page

اختیاری integer

تعداد نتایج در صفحه. مقادیر قابل استفاده: 10, 25, 50, 100. Defaults to: 10.

نمایش

endpoint در API:

GET

https://statsfa.com/api/v1/websites/{id}

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

curl --location --request GET 'https://statsfa.com/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

ذخیره

endpoint در API:

POST

https://statsfa.com/api/v1/websites

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

curl --location --request POST 'https://statsfa.com/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'

پارامتر

نوع

توضیحات

domain

الزامی string

The domain name.

privacy

اختیاری integer

حریم خصوصی صفحه آمار مقادیر قابل استفاده: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور. Defaults to: 0.

password

اختیاری string

رمز عبور برای صفحات آمار محافظت شده. زمانی اجرا می شود که privacy تنظیم شده به 2.

email

اختیاری integer

ایمیل دوره ای گزارش ها مقادیر قابل استفاده: 0 برای غیر فعال, 1 برای فعال. Defaults to: 0.

exclude_bots

اختیاری integer

فعال بودن این گزینه فعالیت های ربات ها را محاسبه نمی کند. مقادیر قابل استفاده: 0 برای غیر فعال, 1 برای فعال. Defaults to: 1.

exclude_params

اختیاری string

Exclude URL query parameters from being tracked. هر خط یک رکورد..

exclude_ips

اختیاری string

اگر آدرس IP خاصی را اضافه کنید، ترافیمک وارده از آن IP ثبت نخواهد شد. هر خط یک رکورد..

بروزرسانی

endpoint در API:

PUT PATCH

https://statsfa.com/api/v1/websites/{id}

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

curl --location --request PUT 'https://statsfa.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 خاصی را اضافه کنید، ترافیمک وارده از آن IP ثبت نخواهد شد. هر خط یک رکورد..

favorite

اختیاری boolean

Whether the website is favorite or not.

حذف

endpoint در API:

DELETE

https://statsfa.com/api/v1/websites/{id}

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

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

آیا از امکانات استتسفا راضی هستید؟