Berichte

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

Die API umfasst Berichte, Projekte und Kontodaten. SEO-Tools lassen sich nicht über die API starten.

Verfügbar in Tarifen mit API, sonst antwortet der Server mit 403. Limits: 60 Anfragen pro Minute, 10 pro Minute für das Erstellen und Aktualisieren von Berichten.

Liste

API-Endpunkt:

GET 
https://itseo.pro/api/v1/reports

Beispielanfrage: 

curl --location --request GET 'https://itseo.pro/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. Standard: url.
project
optional string
Der Projektname.
result
optional string
Das Berichtsergebnis. Mögliche Werte sind: good für Gut, decent für Ordentlich, 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. Standard: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standard: desc.
per_page
optional int
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standard: 100.
Anzeigen

API-Endpunkt:

GET 
https://itseo.pro/api/v1/reports/{id}

Beispielanfrage: 

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

API-Endpunkt:

POST 
https://itseo.pro/api/v1/reports

Beispielanfrage: 

curl --location --request POST 'https://itseo.pro/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
Datenschutz der Berichtsseite. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standard: 1.
password
optional string
Das Passwort für die Berichtsseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://itseo.pro/api/v1/reports/{id}

Beispielanfrage: 

curl --location --request PUT 'https://itseo.pro/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
privacy
optional integer
Datenschutz der Berichtsseite. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
password
optional string
Das Passwort für die Berichtsseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
results
optional integer
Berichtsergebnisse aktualisieren. Mögliche Werte sind: 0 für Nein, 1 für Ja. Standard: 0.
Löschen

API-Endpunkt:

DELETE 
https://itseo.pro/api/v1/reports/{id}

Beispielanfrage: 

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