تعداد گزارش

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

نقطه پایانی آی پی ای:

GET 
https://seo.listori.ir/api/v1/reports

درخواست نمونه: 

curl --location --request GET 'https://seo.listori.ir/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع اطلاعیه
شرح
search
اختیاری string
پرس و جوی جستجو
search_by
اختیاری string
جستجو توسط. مقادیر ممکن عبارتند از are: url برای آدرس. پیشفرض to: url.
project
اختیاری string
نام پروژه
result
اختیاری string
The report result. مقادیر ممکن عبارتند از are: good برای خوب, decent برای محبوب, bad برای بد.
sort_by
اختیاری string
مرتب سازی بر اساس. مقادیر ممکن عبارتند از are: id برای تاریخ ایجاد, generated_at برای تاریخ ایجاد, url برای آدرس, result برای نتیجه. پیشفرض to: id.
sort
اختیاری string
مرتب سازی. مقادیر ممکن عبارتند از are: desc برای نزولی, asc برای صعودی. پیشفرض to: desc.
per_page
اختیاری int
نتایج در هر صفحه. مقادیر ممکن عبارتند از are: 10, 25, 50, 100. پیشفرض to: 10.
نمایش

نقطه پایانی آی پی ای:

GET 
https://seo.listori.ir/api/v1/reports/{id}

درخواست نمونه: 

curl --location --request GET 'https://seo.listori.ir/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
فروشگاه

نقطه پایانی آی پی ای:

POST 
https://seo.listori.ir/api/v1/reports

درخواست نمونه: 

curl --location --request POST 'https://seo.listori.ir/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
پارامتر
نوع اطلاعیه
شرح
url
ضروری string
The webpage's URL.
privacy
اختیاری integer
Report page privacy. مقادیر ممکن عبارتند از are: 0 برای عمومی, 1 برای خصوصی, 2 برای کلمه عبور. پیشفرض to: 1.
password
اختیاری string
The password for the report page. Only works with privacy set to 2.
بروزرسانی

نقطه پایانی آی پی ای:

PUT PATCH 
https://seo.listori.ir/api/v1/reports/{id}

درخواست نمونه: 

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

نقطه پایانی آی پی ای:

DELETE 
https://seo.listori.ir/api/v1/reports/{id}

درخواست نمونه: 

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