Websites

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

API Endpunkt:

GET 
https://stat.vogel-merzig.com/api/v1/websites

Beispiel anfordern: 

curl --location --request GET 'https://stat.vogel-merzig.com/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchabfrage.
search_by
optional string
Suche nach. Mögliche Werte sind: domain für Domain. Standardmäßig ist: domain.
favorite
optional boolean
Filter by favorite.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, domain für Domain. Standardmäßig ist: id.
sort
optional string
Sort. 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: 25.
Anzeigen

API Endpunkt:

GET 
https://stat.vogel-merzig.com/api/v1/websites/{id}

Beispiel anfordern: 

curl --location --request GET 'https://stat.vogel-merzig.com/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speichern

API Endpunkt:

POST 
https://stat.vogel-merzig.com/api/v1/websites

Beispiel anfordern: 

curl --location --request POST 'https://stat.vogel-merzig.com/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Parameter
Typ
Beschreibung
domain
erforderlich string
Domainname.
privacy
optional integer
Datenschutz der Statistikseite. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standardmäßig ist: 0.
password
optional string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
email
optional integer
Regelmäßige E-Mail-Berichte. Mögliche Werte sind: 0 für Deaktiviert, 1 für Aktiviert. Standardmäßig ist: 0.
exclude_bots
optional integer
Häufige Bots von der Nachverfolgung ausschließen. Mögliche Werte sind: 0 für Deaktiviert, 1 für Aktiviert. Standardmäßig ist: 1.
exclude_params
optional string
Exclude URL query parameters from being tracked. Eine pro Zeile..
exclude_ips
optional string
IPs von der Nachverfolgung ausschließen. Eine pro Zeile..
Aktualisieren

API Endpunkt:

PUT PATCH 
https://stat.vogel-merzig.com/api/v1/websites/{id}

Beispiel anfordern: 

curl --location --request PUT 'https://stat.vogel-merzig.com/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
privacy
optional integer
Datenschutz der Statistikseite. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
password
optional string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
email
optional integer
Regelmäßige E-Mail-Berichte. Mögliche Werte sind: 0 für Deaktiviert, 1 für Aktiviert.
exclude_bots
optional integer
Häufige Bots von der Nachverfolgung ausschließen. Mögliche Werte sind: 0 für Deaktiviert, 1 für Aktiviert.
exclude_params
optional string
Exclude URL query parameters from being tracked. Eine pro Zeile..
exclude_ips
optional string
IPs von der Nachverfolgung ausschließen. Eine pro Zeile..
favorite
optional boolean
Whether the website is favorite or not.
Löschen

API Endpunkt:

DELETE 
https://stat.vogel-merzig.com/api/v1/websites/{id}

Beispiel anfordern: 

curl --location --request DELETE 'https://stat.vogel-merzig.com/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'