تقارير

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

نقطة نهاية API:

GET 
https://arabseo.com/api/v1/reports

مثال الطلب: 

curl --location --request GET 'https://arabseo.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 لـ الرابط, result لـ النتيجة. الافتراضي هو: id.
sort
اختياري string
ترتيب. القيم الممكنة هي: desc لـ تنازلي, asc لـ تصاعدي. الافتراضي هو: desc.
per_page
اختياري integer
النتائج في كل صفحة. القيم الممكنة هي: 10, 25, 50, 100. الافتراضي هو: 10.
عرض

نقطة نهاية API:

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

مثال الطلب: 

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

نقطة نهاية API:

POST 
https://arabseo.com/api/v1/reports

مثال الطلب: 

curl --location --request POST 'https://arabseo.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://arabseo.com/api/v1/reports/{id}

مثال الطلب: 

curl --location --request PUT 'https://arabseo.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://arabseo.com/api/v1/reports/{id}

مثال الطلب: 

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