Raporlar - Geliştiriciler

Notlar

Expert level

API anahtarı, isteğin yetkilendirme başlığında bir taşıyıcı belirteci olarak gönderilmelidir. API anahtarınızı alın.

Liste

API uç noktası:

GET

https://www.test.ganikaraoglu.com/api/v1/reports

Örnek talep et:

curl --location --request GET 'https://www.test.ganikaraoglu.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

Şuna göre ara. Olası değerler şunlardır: 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 şunlardır: İyi için good, Orta için decent, Kötü için bad.

sort_by

i̇steğe bağlı string

Sırala. Olası değerler şunlardır: 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ıralama. Olası değerler şunlardır: Azalan için desc, Artan için asc. Varsayılan: desc.

per_page

i̇steğe bağlı integer

Sayfa başına sonuçlar. Olası değerler şunlardır: 10, 25, 50, 100. Varsayılan: 10.

Göster

API uç noktası:

GET

https://www.test.ganikaraoglu.com/api/v1/reports/{id}

Örnek talep et:

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

Depola

API uç noktası:

POST

https://www.test.ganikaraoglu.com/api/v1/reports

Örnek talep et:

curl --location --request POST 'https://www.test.ganikaraoglu.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

gerekli string

The webpage's URL.

privacy

i̇steğe bağlı integer

Report page privacy. Olası değerler şunlardır: 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://www.test.ganikaraoglu.com/api/v1/reports/{id}

Örnek talep et:

curl --location --request PUT 'https://www.test.ganikaraoglu.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 şunlardır: 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 şunlardır: Hayır için 0, Evet için 1. Varsayılan: 0.

Sil

API uç noktası:

DELETE

https://www.test.ganikaraoglu.com/api/v1/reports/{id}

Örnek talep et:

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