Berichte - Entwickler

Authentifizierung

Der API-Schlüssel muss als Bearer-Token im Authorization-Header der Anfrage übermittelt werden. API-Schlüssel abrufen.

Liste

API-Endpunkt

GET

https://www.spyseo.de/public/api/v1/reports

Beispielanfrage

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

Parameters

Name

Typ

Beschreibung

search

optional string

Suchanfrage.

search_by

optional string

Suchen nach. Mögliche Werte sind: url für URL. Standardwert: url.

website_id

optional integer

Website-ID.

result

optional string

Ergebnis. Mögliche Werte sind: good für Sehr Gut, decent für Gut, bad für Schlecht.

sort_by

optional string

Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, url für URL, score für Punktzahl. 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://www.spyseo.de/public/api/v1/reports/{id}

Beispielanfrage

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

Speichern

API-Endpunkt

POST

https://www.spyseo.de/public/api/v1/reports

Beispielanfrage

curl --location --request POST 'https://www.spyseo.de/public/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Parameters

Name

Typ

Beschreibung

url

erforderlich string

URL.

Löschen

API-Endpunkt

DELETE

https://www.spyseo.de/public/api/v1/reports/{id}

Beispielanfrage

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