Berichte

Notizen
Expert level
Der API -Schlüssel sollte als Trägertoken in der Autorisierungsheader der Anfrage gesendet werden. Holen Sie sich Ihren API -Schlüssel.
Liste

API -Endpunkt:

GET 
https://koaz.net/api/v1/reports

Beispiel anfordern: 

curl --location --request GET 'https://koaz.net/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Suchanfrage.
search_by
optional string
Suche nach. Mögliche Werte sind:: Werte. Standardeinstellungen an :: Wert.
project
optional string
Projektname
result
optional string
The report result. Mögliche Werte sind:: Werte.
sort_by
optional string
Sortieren. Mögliche Werte sind:: Werte. Standardeinstellungen an :: Wert.
sort
optional string
Sortieren. Mögliche Werte sind:: Werte. Standardeinstellungen an :: Wert.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind:: Werte. Standardeinstellungen an :: Wert.
Zeigen

API -Endpunkt:

GET 
https://koaz.net/api/v1/reports/{id}

Beispiel anfordern: 

curl --location --request GET 'https://koaz.net/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speichern

API -Endpunkt:

POST 
https://koaz.net/api/v1/reports

Beispiel anfordern: 

curl --location --request POST 'https://koaz.net/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Typ
Beschreibung
url
erforderlich string
The webpage's URL.
privacy
optional integer
Report page privacy. Mögliche Werte sind:: Werte. Standardeinstellungen an :: Wert.
password
optional string
The password for the report page. Funktioniert nur mit: Feldfeld festgelegt auf: Wert.
Aktualisieren

API -Endpunkt:

PUT PATCH 
https://koaz.net/api/v1/reports/{id}

Beispiel anfordern: 

curl --location --request PUT 'https://koaz.net/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
privacy
optional integer
Report page privacy. Mögliche Werte sind:: Werte.
password
optional string
The password for the report page. Funktioniert nur mit: Feldfeld festgelegt auf: Wert.
update
optional integer
Aktualisieren. Mögliche Werte sind:: Werte. Standardeinstellungen an :: Wert.
Löschen

API -Endpunkt:

DELETE 
https://koaz.net/api/v1/reports/{id}

Beispiel anfordern: 

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