Hesabatlar

Qeydlər
Expert level
API açarı sorğunun Səlahiyyət başlığında Daşıyıcı jetonu kimi göndərilməlidir. API açarınızı əldə edin.
Siyahı

API son nöqtəsi:

GET 
https://seo.markup.az/api/v1/reports

Sorğu nümunəsi: 

curl --location --request GET 'https://seo.markup.az/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Növ
Təsvir
search
i̇xtiyari string
Axtarış sorğusu.
search_by
i̇xtiyari string
Üzrə axtar. Mümkün dəyərlər: url URL üçün. Varsayılan: url.
project
i̇xtiyari string
Layihə adı.
result
i̇xtiyari string
The report result. Mümkün dəyərlər: good Yaxşı üçün, decent Kifayət qədər yaxşı üçün, bad Pis üçün.
sort_by
i̇xtiyari string
Sıralamaq. Mümkün dəyərlər: id Yaradılma tarixi üçün, generated_at Yaradılma tarixi üçün, url URL üçün, result Nəticə üçün. Varsayılan: id.
sort
i̇xtiyari string
Sıralamaq. Mümkün dəyərlər: desc Azalan üçün, asc Artan üçün. Varsayılan: desc.
per_page
i̇xtiyari integer
Səhifə başına nəticələr. Mümkün dəyərlər: 10, 25, 50, 100. Varsayılan: 10.
Göstər

API son nöqtəsi:

GET 
https://seo.markup.az/api/v1/reports/{id}

Sorğu nümunəsi: 

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

API son nöqtəsi:

POST 
https://seo.markup.az/api/v1/reports

Sorğu nümunəsi: 

curl --location --request POST 'https://seo.markup.az/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametr
Növ
Təsvir
url
tələb olunur string
The webpage's URL.
privacy
i̇xtiyari integer
Report page privacy. Mümkün dəyərlər: 0 İctimai üçün, 1 Şəxsi üçün, 2 Şifrə üçün. Varsayılan: 0.
password
i̇xtiyari string
The password for the report page. Only works with privacy set to 2.
Yenilə

API son nöqtəsi:

PUT PATCH 
https://seo.markup.az/api/v1/reports/{id}

Sorğu nümunəsi: 

curl --location --request PUT 'https://seo.markup.az/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametr
Növ
Təsvir
privacy
i̇xtiyari integer
Report page privacy. Mümkün dəyərlər: 0 İctimai üçün, 1 Şəxsi üçün, 2 Şifrə üçün.
password
i̇xtiyari string
The password for the report page. Only works with privacy set to 2.
results
i̇xtiyari integer
Update the report results. Mümkün dəyərlər: 0 Xeyr üçün, 1 Bəli üçün. Varsayılan: 0.
Sil

API son nöqtəsi:

DELETE 
https://seo.markup.az/api/v1/reports/{id}

Sorğu nümunəsi: 

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