المواقع

Notes
مستوى الخبراء
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

نقطة نهاية API:

GET 
https://analytics.mnjz.sa/api/v1/websites

Request example: 

curl --location --request GET 'https://analytics.mnjz.sa/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
النوع
الوصف
search
optional string
The search query.
search_by
optional string
البحث بواسطة. Possible values are: domain for النطاق. Defaults to: domain.
sort_by
optional string
Sort by. Possible values are: id for تاريخ الإنشاء, domain for النطاق. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional int
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

نقطة نهاية API:

GET 
https://analytics.mnjz.sa/api/v1/websites/{id}

Request example: 

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

نقطة نهاية API:

POST 
https://analytics.mnjz.sa/api/v1/websites

Request example: 

curl --location --request POST 'https://analytics.mnjz.sa/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Parameter
النوع
الوصف
domain
required string
اسم النطاق
privacy
optional integer
Stats page privacy. Possible values are: 0 for عام, 1 for خاص, 2 for كلمة المرور. Defaults to: 1.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
تقارير البريد الإلكتروني الدورية. Possible values are: 0 for اللغاء التفعيل, 1 for تفعيل. Defaults to: 0.
exclude_bots
optional integer
استبعاد برامج التتبع الشائعة من التعقب. Possible values are: 0 for اللغاء التفعيل, 1 for تفعيل. Defaults to: 1.
exclude_params
optional string
Exclude URL query parameters from being tracked. واحد في كل سطر..
exclude_ips
optional string
استبعاد عناوين IP من التتبع. واحد في كل سطر..
Update

نقطة نهاية API:

PUT PATCH 
https://analytics.mnjz.sa/api/v1/websites/{id}

Request example: 

curl --location --request PUT 'https://analytics.mnjz.sa/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
النوع
الوصف
privacy
optional integer
Stats page privacy. Possible values are: 0 for عام, 1 for خاص, 2 for كلمة المرور.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
تقارير البريد الإلكتروني الدورية. Possible values are: 0 for اللغاء التفعيل, 1 for تفعيل.
exclude_bots
optional integer
استبعاد برامج التتبع الشائعة من التعقب. Possible values are: 0 for اللغاء التفعيل, 1 for تفعيل.
exclude_params
optional string
Exclude URL query parameters from being tracked. واحد في كل سطر..
exclude_ips
optional string
استبعاد عناوين IP من التتبع. واحد في كل سطر..
حذف

نقطة نهاية API:

DELETE 
https://analytics.mnjz.sa/api/v1/websites/{id}

Request example: 

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