Jelentések

Megjegyzések
Expert level
Az API kulcsot Bearer tokenként kell elküldeni a kérés Authorization fejlécében. API kulcsod beszerzése.
Lista

API végpont:

GET 
https://www.traxxaswebhosting.ch/api/v1/reports

Kérés példája: 

curl --location --request GET 'https://www.traxxaswebhosting.ch/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paraméter
Típus
Leírás
search
opcionális string
Keresési lekérdezés.
search_by
opcionális string
Keresés alapján. Lehetséges értékek: url a(z) URL elemhez. Alapértelmezett: url.
project
opcionális string
Projekt neve
result
opcionális string
The report result. Lehetséges értékek: good a(z) Jó elemhez, decent a(z) Közepes elemhez, bad a(z) Rossz elemhez.
sort_by
opcionális string
Rendezés alapján. Lehetséges értékek: id a(z) Létrehozás dátuma elemhez, generated_at a(z) Készítés dátuma elemhez, url a(z) URL elemhez, score a(z) Pontszám elemhez. Alapértelmezett: id.
sort
opcionális string
Rendezés. Lehetséges értékek: desc a(z) Csökkenő elemhez, asc a(z) Növekvő elemhez. Alapértelmezett: desc.
per_page
opcionális integer
Eredmény lapzónként. Lehetséges értékek: 10, 25, 50, 100. Alapértelmezett: 10.
Megjelenítés

API végpont:

GET 
https://www.traxxaswebhosting.ch/api/v1/reports/{id}

Kérés példája: 

curl --location --request GET 'https://www.traxxaswebhosting.ch/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Tárolás

API végpont:

POST 
https://www.traxxaswebhosting.ch/api/v1/reports

Kérés példája: 

curl --location --request POST 'https://www.traxxaswebhosting.ch/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 a(z) Nyilvános elemhez, 1 a(z) Privát elemhez, 2 a(z) Jelszó elemhez. Alapértelmezett: 0.
password
opcionális string
The password for the report page. Csak akkor működik, ha a(z) privacy mező 2 értékre van beállítva.
Frissítés

API végpont:

PUT PATCH 
https://www.traxxaswebhosting.ch/api/v1/reports/{id}

Kérés példája: 

curl --location --request PUT 'https://www.traxxaswebhosting.ch/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 a(z) Nyilvános elemhez, 1 a(z) Privát elemhez, 2 a(z) Jelszó elemhez.
password
opcionális string
The password for the report page. Csak akkor működik, ha a(z) privacy mező 2 értékre van beállítva.
update
opcionális integer
Frissítés. Lehetséges értékek: 0 a(z) Nem elemhez, 1 a(z) Igen elemhez. Alapértelmezett: 0.
Törlés

API végpont:

DELETE 
https://www.traxxaswebhosting.ch/api/v1/reports/{id}

Kérés példája: 

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