Berichte

Notizen
Expert level
Der API-Schlüssel sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. Holen Sie sich Ihren API-Schlüssel.
Liste

API-Endpunkt:

GET 
https://seoa.ch/api/v1/reports

Anfragebeispiel: 

curl --location --request GET 'https://seoa.ch/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suchen nach. Mögliche Werte sind: url für URL. Standardwert: url.
project
optional string
Der Projektname.
result
optional string
The report result. Mögliche Werte sind: good für Gut, decent für Anständig, bad für Schlecht.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, generated_at für Generierungsdatum, url für URL, result für Ergebnis. Standardwert: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardwert: desc.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardwert: 10.
Anzeigen

API-Endpunkt:

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

Anfragebeispiel: 

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

API-Endpunkt:

POST 
https://seoa.ch/api/v1/reports

Anfragebeispiel: 

curl --location --request POST 'https://seoa.ch/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: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standardwert: 0.
password
optional string
The password for the report page. Only works with privacy set to 2.
Aktualisieren

API-Endpunkt:

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

Anfragebeispiel: 

curl --location --request PUT 'https://seoa.ch/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: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
password
optional string
The password for the report page. Only works with privacy set to 2.
results
optional integer
Update the report results. Mögliche Werte sind: 0 für Nein, 1 für Ja. Standardwert: 0.
Löschen

API-Endpunkt:

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

Anfragebeispiel: 

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