سایت ها

یادداشت ها
سطح کارشناسی
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
لیست

API endpoint:

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

Request example: 

curl --location --request GET 'https://www.iranstats.ir/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
search
optional string
The search query.
search_by
optional string
جستجو بر اساس. Possible values are: domain for دامنه. Defaults to: domain.
favorite
optional boolean
فیلتر بر اساس موارد دلخواه
sort_by
optional string
Sort by. Possible values are: id for تاریخ ایجاد, domain for دامنه. Defaults to: id.
sort
optional string
ترتیب. Possible values are: desc for نزولی, asc for صعودی. Defaults to: desc.
per_page
optional integer
نتایج در هر صفحه. Possible values are: 10, 25, 50, 100. Defaults to: 25.
نمایش

API endpoint:

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

Request example: 

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

API endpoint:

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

Request example: 

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 'domain={domain}'
پارامتر
نوع
توضیحات
domain
required string
The domain name.
privacy
optional integer
Stats page privacy. Possible values are: 0 for عمومی, 1 for خصوصی, 2 for رمز عبور. Defaults to: 0.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
Periodic email reports. Possible values are: 0 for غیرفعال, 1 for فعال. Defaults to: 0.
exclude_bots
optional integer
Exclude common bots from being tracked. 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
Exclude IPs from being tracked. هر خط یکی.
بروز رسانی

API endpoint:

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

Request example: 

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}'
پارامتر
نوع
توضیحات
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
Periodic email reports. Possible values are: 0 for غیرفعال, 1 for فعال.
exclude_bots
optional integer
Exclude common bots from being tracked. Possible values are: 0 for غیرفعال, 1 for فعال.
exclude_params
optional string
Exclude URL query parameters from being tracked. هر خط یکی.
exclude_ips
optional string
Exclude IPs from being tracked. هر خط یکی.
favorite
optional boolean
این که آیا وب سایت مورد علاقه است یا خیر.
حذف

API endpoint:

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

Request example: 

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