گزارشات

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

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

GET 
https://tools.jetserp.com/api/v1/reports

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

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

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

GET 
https://tools.jetserp.com/api/v1/reports/{id}

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

curl --location --request GET 'https://tools.jetserp.com/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
ذخیره

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

POST 
https://tools.jetserp.com/api/v1/reports

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

curl --location --request POST 'https://tools.jetserp.com/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. مقادیر ممکن هستند: 0 برای عمومی, 1 برای خصوصی, 2 برای کلمه عبور. پیش فرض به: 0.
password
اختیاری string
The password for the report page. Only works with privacy set to 2.
بروزرسانی

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

PUT PATCH 
https://tools.jetserp.com/api/v1/reports/{id}

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

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

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

DELETE 
https://tools.jetserp.com/api/v1/reports/{id}

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

curl --location --request DELETE 'https://tools.jetserp.com/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'