تقارير

ملاحظات
Expert level
يجب إرسال مفتاح API كرمز Bearer في ترويسة التفويض (Authorization) الخاصة بالطلب. احصل على مفتاح API الخاص بك.
قائمة

نقطة نهاية API:

GET 
https://seo.zero-cart.com/api/v1/reports

مثال على الطلب: 

curl --location --request GET 'https://seo.zero-cart.com/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://seo.zero-cart.com/api/v1/reports/{id}

مثال على الطلب: 

curl --location --request GET 'https://seo.zero-cart.com/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
تخزين

نقطة نهاية API:

POST 
https://seo.zero-cart.com/api/v1/reports

مثال على الطلب: 

curl --location --request POST 'https://seo.zero-cart.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. يعمل فقط عندما يكون الحقل privacy مضبوطًا على 2.
تحديث

نقطة نهاية API:

PUT PATCH 
https://seo.zero-cart.com/api/v1/reports/{id}

مثال على الطلب: 

curl --location --request PUT 'https://seo.zero-cart.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. يعمل فقط عندما يكون الحقل privacy مضبوطًا على 2.
update
اختياري integer
تحديث. القيم الممكنة هي: 0 لـ لا, 1 لـ نعم. الإعداد الافتراضي هو: 0.
حذف

نقطة نهاية API:

DELETE 
https://seo.zero-cart.com/api/v1/reports/{id}

مثال على الطلب: 

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