وب‌سایت‌ها

دریافت همه

نقطه پایانی

GET https://data.cheraghestan.com/api/websites/

مثال

curl --request GET \
--url 'https://data.cheraghestan.com/api/websites/' \
--header 'Authorization: Bearer {api_key}' \

پارامترها	جزئیات	توضیحات
search	اختیاری رشته	رشته جستجو.
search_by	اختیاری رشته	بر اساس چه فیلدی جستجو می‌کنید. مقادیر مجاز: `name`, `host`.
is_enabled	اختیاری عدد صحیح
tracking_type	اختیاری رشته	مقادیر مجاز: `normal`, `lightweight`
datetime_field	اختیاری رشته	مقادیر مجاز: `datetime`, `last_datetime`
datetime_start	اختیاری رشته	نتایج را از این تاریخ و زمان شروع فیلتر کنید. فرمت `Y-m-d H:i:s`.
datetime_end	اختیاری رشته	نتایج را تا این تاریخ و زمان فیلتر کنید. فرمت `Y-m-d H:i:s`.
order_by	اختیاری رشته	مرتب‌سازی نتایج بر اساس چه فیلدی. مقادیر مجاز: `website_id`, `datetime`, `last_datetime`, `name`, `host`, `current_month_sessions_events`.
order_type	اختیاری رشته	ترتیب نتایج. مقادیر مجاز: `ASC` برای ترتیب صعودی، و `DESC` برای ترتیب نزولی.
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": "",
            "outbound_clicks_is_enabled": false,
            "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-10-13 14:38:44",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://data.cheraghestan.com/api/websites?page=1",
        "last": "https://data.cheraghestan.com/api/websites?page=1",
        "next": null,
        "prev": null,
        "self": "https://data.cheraghestan.com/api/websites?page=1"
    }
}

دریافت یکی

نقطه پایانی

GET https://data.cheraghestan.com/api/websites/{website_id}

مثال

curl --request GET \
--url 'https://data.cheraghestan.com/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": "",
        "outbound_clicks_is_enabled": false,
        "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-10-13 14:38:44",
        "last_datetime": null
    }
}

curl --request POST \
--url 'https://data.cheraghestan.com/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://data.cheraghestan.com/api/websites/{website_id}

پارامترها	جزئیات	توضیحات
domain_id	اختیاری عدد صحیح	-
name	اختیاری رشته	-
scheme	اختیاری رشته	مقادیر مجاز: `http://`, `https://`
host	اختیاری رشته	مثال: `example.com/path`.
excluded_ips	اختیاری رشته	حذف IPها از ردیابی. مقادیر جدا شده با کاما وارد کنید.
outbound_clicks_is_enabled	اختیاری بولین
events_children_is_enabled	اختیاری بولین	ردیابی رویدادهای بازدیدکننده (کلیک ماوس، تغییر اندازه، اسکرول، ارسال فرم). مقادیر مجاز: `0` یا `1`. فقط برای نوع ردیابی `normal` در دسترس است.
sessions_replays_is_enabled	اختیاری بولین	بازپخش جلسات. مقادیر مجاز: `0` یا `1`. فقط برای نوع ردیابی `normal` در دسترس است.
sessions_replays_hide_text_selector	اختیاری رشته
email_reports_is_enabled	اختیاری بولین	گزارش‌های ایمیلی. مقادیر مجاز: `0` یا `1`.
ip_storage_is_enabled	اختیاری بولین	در دسترس زمانی که: tracking_type = normal
query_parameters_tracking_is_enabled	اختیاری بولین	-
bot_exclusion_is_enabled	اختیاری بولین	-
public_statistics_is_enabled	اختیاری بولین	-
public_statistics_password	اختیاری رشته	-
is_enabled	اختیاری بولین	-

مثال

curl --request POST \
--url 'https://data.cheraghestan.com/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://data.cheraghestan.com/api/websites/{website_id}

مثال

curl --request DELETE \
--url 'https://data.cheraghestan.com/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \

دریافت همه

دریافت یکی

ایجاد

به‌روزرسانی

حذف