گزارشات

یادداشت ها
Expert level
کلید API باید به عنوان یک توکن حامل در هدر مجوز درخواست ارسال شود کلید API خود را دریافت کنید..
لیست

API endpoint:

GET 
https://rank.qomitc.ir/api/v1/reports

Request example: 

curl --location --request GET 'https://rank.qomitc.ir/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
نوع
توضیحات
search
optional string
The search query.
search_by
optional string
جستجو توسط. Possible values are: url برای آدرس سایت. Defaults to: url.
project
optional string
The project name.
result
optional string
The report result. Possible values are: good برای وضعیت خوب, decent برای متوسط نیاز به بهینه سازی, bad برای بد و غیر قابل قبول.
sort_by
optional string
مرتبط سازی توسط. Possible values are: id برای Date created, generated_at برای تاریخ تولید, url برای آدرس سایت, result برای نتیجه. Defaults to: id.
sort
optional string
مرتب سازی. Possible values are: desc برای Descending, asc برای Ascending. Defaults to: desc.
per_page
optional int
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
نمایش

API endpoint:

GET 
https://rank.qomitc.ir/api/v1/reports/{id}

Request example: 

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

API endpoint:

POST 
https://rank.qomitc.ir/api/v1/reports

Request example: 

curl --location --request POST 'https://rank.qomitc.ir/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
نوع
توضیحات
url
required string
The webpage's URL.
privacy
optional integer
Report page privacy. Possible values are: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور. Defaults to: 1.
password
optional string
The password for the report page. Only works with privacy set to 2.
بروزرسانی

API endpoint:

PUT PATCH 
https://rank.qomitc.ir/api/v1/reports/{id}

Request example: 

curl --location --request PUT 'https://rank.qomitc.ir/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
نوع
توضیحات
privacy
optional integer
Report page privacy. Possible values are: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور.
password
optional string
The password for the report page. Only works with privacy set to 2.
results
optional integer
Update the report results. Possible values are: 0 برای خیر, 1 برای بله. Defaults to: 0.
حذف

API endpoint:

DELETE 
https://rank.qomitc.ir/api/v1/reports/{id}

Request example: 

curl --location --request DELETE 'https://rank.qomitc.ir/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'