وب سایت ها
GET https://usermap.net/api/websites/
curl --request GET \
--url 'https://usermap.net/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://usermap.net/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
| مولفه های | جزئیات | توضیحات |
|---|---|---|
| page | اختیاری Integer | شماره صفحه ای که می خواهید از آن نتیجه بگیرید. پیشفرض 1 است. |
| results_per_page | اختیاری Integer | در هر صفحه چند نتیجه می خواهید. مقادیر مجاز عبارتند از: 10 , 25 , 50 , 100 , 250 , 500. پیشفرض 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",
"is_enabled": true,
"date": "2019-11-01 12:00:30"
},
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://usermap.net/api/websites?&page=1",
"last": "https://usermap.net/api/websites?&page=1",
"next": null,
"prev": null,
"self": "https://usermap.net/api/websites?&page=1"
}
}
GET https://usermap.net/api/websites/{website_id}
curl --request GET \
--url 'https://usermap.net/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://usermap.net/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",
"is_enabled": true,
"date": "2019-11-01 12:00:30"
}
}
POST https://usermap.net/api/websites
| مولفه های | جزئیات | توضیحات |
|---|---|---|
| name | ضروری String | - |
| scheme | اختیاری String | مقادیر مجاز عبارتند از: http:// و https://. |
| host | ضروری String | میزبان وب سایت و مسیر. مثال: https://example.com/path. |
| tracking_type | اختیاری String | مقادیر مجاز عبارتند از: سبک و نرمال. |
| excluded_ips | اختیاری String | IP ها را از ردیابی حذف کنید. مقادیر جدا شده با کاما را وارد کنید. |
| events_children_is_enabled | اختیاری Boolean | رویدادهای بازدیدکننده (کلیک های ماوس، تغییر اندازه، اسکرول، ارسال فرم ها) را ردیابی کنید. مقادیر مجاز عبارتند از: 0 یا 1. فقط برای نوع ردیابی عادی موجود است. |
| sessions_replays_is_enabled | اختیاری Boolean | تکرار جلسه مقادیر مجاز عبارتند از: 0 یا 1. فقط برای نوع ردیابی عادی موجود است. |
| email_reports_is_enabled | اختیاری Boolean | گزارش های ایمیل مقادیر مجاز عبارتند از: 0 یا 1. |
curl --request POST \
--url 'https://usermap.net/api/websites' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=website.com' \
--form 'name=Example' \
--url 'https://usermap.net/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://usermap.net/api/websites/{website_id}
| مولفه های | جزئیات | توضیحات |
|---|---|---|
| name | اختیاری String | - |
| scheme | اختیاری String | مقادیر مجاز عبارتند از: http:// و https://. |
| host | اختیاری String | میزبان وب سایت و مسیر. مثال: https://example.com/path. |
| excluded_ips | اختیاری String | IP ها را از ردیابی حذف کنید. مقادیر جدا شده با کاما را وارد کنید. |
| events_children_is_enabled | اختیاری Boolean | رویدادهای بازدیدکننده (کلیک های ماوس، تغییر اندازه، اسکرول، ارسال فرم ها) را ردیابی کنید. مقادیر مجاز عبارتند از: 0 یا 1. فقط برای نوع ردیابی عادی موجود است. |
| sessions_replays_is_enabled | اختیاری Boolean | تکرار جلسه مقادیر مجاز عبارتند از: 0 یا 1. فقط برای نوع ردیابی عادی موجود است. |
| email_reports_is_enabled | اختیاری Boolean | گزارش های ایمیل مقادیر مجاز عبارتند از: 0 یا 1. |
| is_enabled | اختیاری Boolean | وضعیت ردیابی وب سایت مقادیر مجاز عبارتند از: 0 یا 1. |
curl --request POST \
--url 'https://usermap.net/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=0' \
--url 'https://usermap.net/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://usermap.net/api/websites/{website_id}
curl --request DELETE \
--url 'https://usermap.net/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://usermap.net/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \