وب‌سایت‌ها

یادداشت‌ها
سطح کاوش
کلید API می‌بایست به عنوان توکن حامل در مجوز سربرگ درخواستی ارسال شود. کلید API خود را دریافت کنید.
لیست

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

GET
https://www.iranstats.ir/api/v1/websites

درخواست نمونه:

curl --location --request GET 'https://www.iranstats.ir/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
search
اختیاری string
پرسش سوال.
sort
اختیاری string
Sort. مقادیر احتمالی: desc برای Z-A, asc برای A-Z هستند.
per_page
اختیاری int
نتایج هرصفحه. مقادیر احتمالی: 10 به 100 هستند. پیشفرض به: 10.
نمایش

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

GET
https://www.iranstats.ir/api/v1/websites/{id}

درخواست نمونه:

curl --location --request GET 'https://www.iranstats.ir/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
فروشگاه

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

POST
https://www.iranstats.ir/api/v1/websites

درخواست نمونه:

curl --location --request POST 'https://www.iranstats.ir/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
پارامتر
نوع
توضیحات
url
ضروری string
URL وب‌سایت.
privacy
اختیاری integer
حریم خصوصی صفحه. مقادیر احتمالی: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور هستند. پیشفرض به: 1.
password
اختیاری string
رمز ورود به صفحه آمار. فقط با privacy تنظیم شده برای 2 کار می‌کند.
email
اختیاری integer
ایمیل کردن دوره‌ای گزارشات. مقادیر احتمالی: 0 برای غیرفعال, 1 برای فعال هستند. پیشفرض به: 0.
exclude_bots
اختیاری integer
مانع آغاز ردیابی ربات‌های رایج مقادیر احتمالی: 0 برای غیرفعال, 1 برای فعال هستند. پیشفرض به: 1.
exclude_ips
اختیاری string
ردیابی IP ها را حذف کنید. در هر خط یکی.
بروزرسانی

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

PUT PATCH
https://www.iranstats.ir/api/v1/websites/{id}

درخواست نمونه:

curl --location --request PUT 'https://www.iranstats.ir/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
پارامتر
نوع
توضیحات
privacy
اختیاری integer
حریم خصوصی صفحه. مقادیر احتمالی: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور هستند.
password
اختیاری string
رمز ورود به صفحه آمار. فقط با privacy تنظیم شده برای 2 کار می‌کند.
email
اختیاری integer
ایمیل کردن دوره‌ای گزارشات. مقادیر احتمالی: 0 برای غیرفعال, 1 برای فعال هستند.
exclude_bots
اختیاری integer
مانع آغاز ردیابی ربات‌های رایج مقادیر احتمالی: 0 برای غیرفعال, 1 برای فعال هستند.
exclude_ips
اختیاری string
ردیابی IP ها را حذف کنید. در هر خط یکی.
حذف

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

DELETE
https://www.iranstats.ir/api/v1/websites/{id}

درخواست نمونه:

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