Riportok

Megjegyzések
Expert level
Az API kulcsot Bearer tokenként kell elküldeni a kérelem Authorization fejlécében. Szerezze meg API-kulcsot.
Lista

API endpoint:

GET 
https://www.seoelemzes.com/api/v1/reports

Példa kérése: 

curl --location --request GET 'https://www.seoelemzes.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paraméter
Típus
Leírás
search
opcionális string
A keresési lekérdezés.
search_by
opcionális string
Keresés. Lehetséges értékek: url for URL. Alapértelmezett: url.
project
opcionális string
A projekt neve.
result
opcionális string
The report result. Lehetséges értékek: good for Jó, decent for Elégséges, bad for Rossz.
sort_by
opcionális string
Rendezés alapja. Lehetséges értékek: id for Létrehozás dátuma, generated_at for Dátum létrehozása, url for URL, result for Eredmény. Alapértelmezett: id.
sort
opcionális string
Rendezés. Lehetséges értékek: desc for Csökkenő, asc for Növekvő. Alapértelmezett: desc.
per_page
opcionális int
Eredmények oldalanként. Lehetséges értékek: 10, 25, 50, 100. Alapértelmezett: 100.
Megjelenítés

API endpoint:

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

Példa kérése: 

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

API endpoint:

POST 
https://www.seoelemzes.com/api/v1/reports

Példa kérése: 

curl --location --request POST 'https://www.seoelemzes.com/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Paraméter
Típus
Leírás
url
kötelező string
The webpage's URL.
privacy
opcionális integer
Report page privacy. Lehetséges értékek: 0 for Nyilvános, 1 for Privát, 2 for Jelszó. Alapértelmezett: 1.
password
opcionális string
The password for the report page. Only works with privacy set to 2.
Frissítés

API endpoint:

PUT PATCH 
https://www.seoelemzes.com/api/v1/reports/{id}

Példa kérése: 

curl --location --request PUT 'https://www.seoelemzes.com/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paraméter
Típus
Leírás
privacy
opcionális integer
Report page privacy. Lehetséges értékek: 0 for Nyilvános, 1 for Privát, 2 for Jelszó.
password
opcionális string
The password for the report page. Only works with privacy set to 2.
results
opcionális integer
Update the report results. Lehetséges értékek: 0 for Nem, 1 for Igen. Alapértelmezett: 0.
Törlés

API endpoint:

DELETE 
https://www.seoelemzes.com/api/v1/reports/{id}

Példa kérése: 

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