Raporlar

Notlar
Expert level
API anahtarı, isteğin Authorization başlığında Bearer token olarak gönderilmelidir. API anahtarınızı alın.
Listele

API uç noktası:

GET
https://seo.webnif.com/api/v1/reports

İstek örneği:

curl --location --request GET 'https://seo.webnif.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametre
Tür
Açıklama
search
i̇steğe bağlı string
Arama sorgusu.
search_by
i̇steğe bağlı string
Arama Kriteri. Olası değerler: URL için url. Varsayılan: url.
project
i̇steğe bağlı string
Proje adı.
result
i̇steğe bağlı string
The report result. Olası değerler: İyi için good, Uygun için decent, Kötü için bad.
sort_by
i̇steğe bağlı string
Sırala. Olası değerler: Oluşturulma tarihi için id, Oluşturulma tarihi için generated_at, URL için url, Sonuç için result. Varsayılan: id.
sort
i̇steğe bağlı string
Sırala. Olası değerler: Azalan için desc, Artan için asc. Varsayılan: desc.
per_page
i̇steğe bağlı integer
Sayfa Başına Sonuç. Olası değerler: 10, 25, 50, 100. Varsayılan: 10.
Göster

API uç noktası:

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

İstek örneği:

curl --location --request GET 'https://seo.webnif.com/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Kaydet

API uç noktası:

POST
https://seo.webnif.com/api/v1/reports

İstek örneği:

curl --location --request POST 'https://seo.webnif.com/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametre
Tür
Açıklama
url
zorunlu string
The webpage's URL.
privacy
i̇steğe bağlı integer
Report page privacy. Olası değerler: Genel için 0, Özel için 1, Şifre için 2. Varsayılan: 0.
password
i̇steğe bağlı string
The password for the report page. Only works with privacy set to 2.
Güncelle

API uç noktası:

PUT PATCH
https://seo.webnif.com/api/v1/reports/{id}

İstek örneği:

curl --location --request PUT 'https://seo.webnif.com/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametre
Tür
Açıklama
privacy
i̇steğe bağlı integer
Report page privacy. Olası değerler: Genel için 0, Özel için 1, Şifre için 2.
password
i̇steğe bağlı string
The password for the report page. Only works with privacy set to 2.
results
i̇steğe bağlı integer
Update the report results. Olası değerler: Hayır için 0, Evet için 1. Varsayılan: 0.
Sil

API uç noktası:

DELETE
https://seo.webnif.com/api/v1/reports/{id}

İstek örneği:

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