Analysen

Anmerkungen
Expert level
Der API-Key sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. API-Key anfordern.
Liste

API endpoint:

GET 
https://dlx-rank.com/api/v1/reports

Beispiel Request: 

curl --location --request GET 'https://dlx-rank.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Search query.
search_by
optional string
Search by. Mögliche Werte sind: url für URL. Standardmäßig ist: url.
project
optional string
Project name
result
optional string
The report result. Mögliche Werte sind: good für Gut, decent für Befriedigend, bad für Ungenügend.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, generated_at für Erstellungsdatum, url für URL, score für Score. Standardmäßig ist: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardmäßig ist: desc.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardmäßig ist: 100.
Anzeigen

API endpoint:

GET 
https://dlx-rank.com/api/v1/reports/{id}

Beispiel Request: 

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

API endpoint:

POST 
https://dlx-rank.com/api/v1/reports

Beispiel Request: 

curl --location --request POST 'https://dlx-rank.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 für Öffentlich, 1 für Privat, 2 für Passwort. Standardmäßig ist: 0.
password
optional string
The password for the report page. Only works with privacy field set to 2.
Aktualisieren

API endpoint:

PUT PATCH 
https://dlx-rank.com/api/v1/reports/{id}

Beispiel Request: 

curl --location --request PUT 'https://dlx-rank.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 für Öffentlich, 1 für Privat, 2 für Passwort.
password
optional string
The password for the report page. Only works with privacy field set to 2.
update
optional integer
Aktualisieren. Mögliche Werte sind: 0 für Nein, 1 für Ja. Standardmäßig ist: 0.
Löschen

API endpoint:

DELETE 
https://dlx-rank.com/api/v1/reports/{id}

Beispiel Request: 

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