Reports

Notes
Expert level
Der API-Schlüssel sollte als Inhaber-Token im Berechtigungskopf der Anfrage gesendet werden. API-Schlüssel erhalten.
Liste

API-Endpunkt:

GET
https://seoeasy.de/api/v1/reports

Beispiel anfordern:

curl --location --request GET 'https://seoeasy.de/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Art
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suchen nach. Mögliche Werte sind: url für URL. Voreingestellter Wert: url.
project
optional string
Der Projektname.
result
optional string
The report result. Mögliche Werte sind: good für Gut, decent für Normal, bad für Schlecht.
sort_by
optional string
Sortiere nach. Mögliche Werte sind: id für Datum erstellt, generated_at für Erzeugtes Datum, url für URL, result für Ergebnis. Voreingestellter Wert: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigen. Voreingestellter Wert: desc.
per_page
optional int
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Voreingestellter Wert: 25.
Anzeigen

API-Endpunkt:

GET
https://seoeasy.de/api/v1/reports/{id}

Beispiel anfordern:

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

API-Endpunkt:

POST
https://seoeasy.de/api/v1/reports

Beispiel anfordern:

curl --location --request POST 'https://seoeasy.de/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Art
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. Voreingestellter Wert: 1.
password
optional string
The password for the report page. Only works with privacy set to 2.
Aktualisieren

API-Endpunkt:

PUT PATCH
https://seoeasy.de/api/v1/reports/{id}

Beispiel anfordern:

curl --location --request PUT 'https://seoeasy.de/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Art
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. Voreingestellter Wert: 0.
Löschen

API-Endpunkt:

DELETE
https://seoeasy.de/api/v1/reports/{id}

Beispiel anfordern:

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