یانکس آنالیز با ابزار حرفه‌ای تحلیل و بهبود سئو ، جهت استفاده بیشتر از بخش پلن ها اشتراک تهیه کنید.

انالیز‌ها

یادداشت‌ها
Expert level
کلید API باید به صورت توکن Bearer در هدر Authorization درخواست ارسال شود. کلید API خود را دریافت کنید.
فهرست

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

GET 
https://www.seo.yunex.ir/api/v1/reports

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

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

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

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

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

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

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

POST 
https://www.seo.yunex.ir/api/v1/reports

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

curl --location --request POST 'https://www.seo.yunex.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. مقادیر ممکن: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور. مقدار پیش‌فرض: 0.
password
اختیاری string
The password for the report page. فقط با مقداردهی privacy به 2 کار می‌کند
به‌روزرسانی

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

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

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

curl --location --request PUT 'https://www.seo.yunex.ir/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. فقط با مقداردهی privacy به 2 کار می‌کند
update
اختیاری integer
به‌روزرسانی. مقادیر ممکن: 0 برای خیر, 1 برای بله. مقدار پیش‌فرض: 0.
حذف

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

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

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

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