Berichte

Anmerkungen
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
Verzeichnis

API endpoint:

GET
https://www.seo-speedster.com/api/v1/reports

Request example:

curl --location --request GET 'https://www.seo-speedster.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suche nach. Mögliche Werte sind: url for URL. Standardmäßig auf: url.
project
optional string
Der Projektname.
result
optional string
The report result. Mögliche Werte sind: good for Sehr Gut, decent for Mittelmäßig, bad for Kritisch.
sort_by
optional string
Sortiere nach. Mögliche Werte sind: id for Datum erstellt, generated_at for Datum generiert, url for URL, result for Ergebnis. Standardmäßig auf: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc for Absteigend, asc for Aufsteigend. Standardmäßig auf: desc.
per_page
optional int
Results per page. Mögliche Werte sind: 10, 25, 50, 100. Standardmäßig auf: 10.
Anzeigen

API endpoint:

GET
https://www.seo-speedster.com/api/v1/reports/{id}

Request example:

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

API endpoint:

POST
https://www.seo-speedster.com/api/v1/reports

Request example:

curl --location --request POST 'https://www.seo-speedster.com/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 for Public, 1 for Privat, 2 for Passwort. Standardmäßig auf: 1.
password
optional string
The password for the report page. Only works with privacy set to 2.
Aktualisieren

API endpoint:

PUT PATCH
https://www.seo-speedster.com/api/v1/reports/{id}

Request example:

curl --location --request PUT 'https://www.seo-speedster.com/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 for Public, 1 for Privat, 2 for 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 for Nein, 1 for Ja. Standardmäßig auf: 0.
Löschen

API endpoint:

DELETE
https://www.seo-speedster.com/api/v1/reports/{id}

Request example:

curl --location --request DELETE 'https://www.seo-speedster.com/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'