وب‌سایت‌ها

GET https://firstanalytics.ir/api/websites/
curl --request GET \
--url 'https://firstanalytics.ir/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
پارامترها جزئیات توضیحات
page اختیاری عدد صحیح شماره صفحه‌ای که می‌خواهید نتایج از آن باشد. به طور پیش‌فرض 1 است.
results_per_page اختیاری عدد صحیح چند نتیجه می‌خواهید در هر صفحه نمایش داده شود؟ مقادیر مجاز عبارتند از: 10 , 25 , 50 , 100 , 250 , 500 , 1000. به طور پیش‌فرض 25 است.
{ "data": [ { "id": 1, "pixel_key": "1234567890123456", "name": "Localhost", "scheme": "https://", "host": "example.com", "path": "/", "tracking_type": "normal", "excluded_ips": "", "events_children_is_enabled": false, "sessions_replays_is_enabled": false, "email_reports_is_enabled": false, "email_reports_last_date": "2020-06-23 19:01:22", "bot_exclusion_is_enabled": true, "query_parameters_tracking_is_enabled": true, "ip_storage_is_enabled": false, "public_statistics_is_enabled": false, "public_statistics_password": false, "is_enabled": true, "datetime": "2026-07-14 16:11:19" "last_datetime": null }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://firstanalytics.ir/api/websites?&page=1", "last": "https://firstanalytics.ir/api/websites?&page=1", "next": null, "prev": null, "self": "https://firstanalytics.ir/api/websites?&page=1" } }
GET https://firstanalytics.ir/api/websites/{website_id}
curl --request GET \
--url 'https://firstanalytics.ir/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "pixel_key": "1234567890123456", "name": "Localhost", "scheme": "https://", "host": "example.com", "path": "/", "tracking_type": "normal", "excluded_ips": "", "events_children_is_enabled": false, "sessions_replays_is_enabled": false, "email_reports_is_enabled": false, "email_reports_last_date": "2020-06-23 19:01:22", "bot_exclusion_is_enabled": true, "query_parameters_tracking_is_enabled": true, "ip_storage_is_enabled": false, "public_statistics_is_enabled": false, "public_statistics_password": false, "is_enabled": true, "datetime": "2026-07-14 16:11:19" "last_datetime": null } }
POST https://firstanalytics.ir/api/websites
پارامترها جزئیات توضیحات
name ضروری رشته -
scheme اختیاری رشته مقادیر مجاز: http://, https://
host ضروری رشته مثال: example.com/path.
tracking_type اختیاری رشته مقادیر مجاز: lightweight, normal
excluded_ips اختیاری رشته آدرس‌های IP را از ردیابی مستثنی کنید. مقادیر را با کاما جدا کنید.
events_children_is_enabled اختیاری بولیانی رویدادهای بازدیدکننده را پیگیری کنید (کلیک‌های ماوس، تغییر اندازه‌ها، اسکرول‌ها، ارسال فرم‌ها). مقادیر مجاز: 0 یا 1. فقط برای نوع ردیابی normal در دسترس است.
sessions_replays_is_enabled اختیاری بولیانی پخش مجدد جلسه. مقادیر مجاز: 0 یا 1. فقط برای نوع ردیابی normal در دسترس است.
email_reports_is_enabled اختیاری بولیانی گزارش‌های ایمیلی. مقادیر مجاز: 0 یا 1.
query_parameters_tracking_is_enabled اختیاری بولیانی -
bot_exclusion_is_enabled اختیاری بولیانی -
public_statistics_is_enabled اختیاری بولیانی -
public_statistics_password اختیاری رشته -
is_enabled اختیاری بولیانی -
curl --request POST \
--url 'https://firstanalytics.ir/api/websites' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=website.com' \
--form 'name=Example' \
{ "data": { "id": 1 } }
POST https://firstanalytics.ir/api/websites/{website_id}
پارامترها جزئیات توضیحات
name اختیاری رشته -
scheme اختیاری رشته مقادیر مجاز: http://, https://
host اختیاری رشته مثال: example.com/path.
excluded_ips اختیاری رشته آدرس‌های IP را از ردیابی مستثنی کنید. مقادیر را با کاما جدا کنید.
events_children_is_enabled اختیاری بولیانی رویدادهای بازدیدکننده را پیگیری کنید (کلیک‌های ماوس، تغییر اندازه‌ها، اسکرول‌ها، ارسال فرم‌ها). مقادیر مجاز: 0 یا 1. فقط برای نوع ردیابی normal در دسترس است.
sessions_replays_is_enabled اختیاری بولیانی پخش مجدد جلسه. مقادیر مجاز: 0 یا 1. فقط برای نوع ردیابی normal در دسترس است.
email_reports_is_enabled اختیاری بولیانی گزارش‌های ایمیلی. مقادیر مجاز: 0 یا 1.
query_parameters_tracking_is_enabled اختیاری بولیانی -
bot_exclusion_is_enabled اختیاری بولیانی -
public_statistics_is_enabled اختیاری بولیانی -
public_statistics_password اختیاری رشته -
is_enabled اختیاری بولیانی -
curl --request POST \
--url 'https://firstanalytics.ir/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=0' \
{ "data": { "id": 1 } }
DELETE https://firstanalytics.ir/api/websites/{website_id}
curl --request DELETE \
--url 'https://firstanalytics.ir/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \