Weblinks

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

API-Endpunkt:

GET 
https://analytics.kreisvier.com/api/v1/websites

Beispiel anfordern: 

curl --location --request GET 'https://analytics.kreisvier.com/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Art
Beschreibung
search
optional string
Die Suchabfrage.
search_by
optional string
Suche nach. Mögliche Werte sind: :Wert für Domain. Der Standardwert ist: domain.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: :Wert für Erstellungsdatum, :Wert für Domain. Der Standardwert ist: id.
sort
optional string
Sortieren. Mögliche Werte sind: :Wert für Absteigend, :Wert für Aufsteigend. Der Standardwert ist: desc.
per_page
optional int
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Der Standardwert ist: 20.
Zeigen

API-Endpunkt:

GET 
https://analytics.kreisvier.com/api/v1/websites/{id}

Beispiel anfordern: 

curl --location --request GET 'https://analytics.kreisvier.com/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Abspeichern

API-Endpunkt:

POST 
https://analytics.kreisvier.com/api/v1/websites

Beispiel anfordern: 

curl --location --request POST 'https://analytics.kreisvier.com/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Parameter
Art
Beschreibung
domain
erforderlich string
The domain name.
privacy
optional integer
Datenschutz auf der Statistikseite. Mögliche Werte sind: :Wert für Öffentlich, :Wert für Privat, :Wert für Passwort. Der Standardwert ist: 1.
password
optional string
Das Kennwort für die Statistikseite. Funktioniert nur mit privacy, das auf 2 gesetzt ist.
email
optional integer
Regelmässige E-Mail-Berichte. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Aktiviert. Der Standardwert ist: 0.
exclude_bots
optional integer
Schliessen Sie gängige Bots von der Nachverfolgung aus. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Aktiviert. Der Standardwert ist: 1.
exclude_params
optional string
Exclude URL query parameters from being tracked. Eine pro Zeile..
exclude_ips
optional string
Schliessen Sie IPs von der Nachverfolgung aus. Eine pro Zeile..
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://analytics.kreisvier.com/api/v1/websites/{id}

Beispiel anfordern: 

curl --location --request PUT 'https://analytics.kreisvier.com/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Art
Beschreibung
privacy
optional integer
Datenschutz auf der Statistikseite. Mögliche Werte sind: :Wert für Öffentlich, :Wert für Privat, :Wert für Passwort.
password
optional string
Das Kennwort für die Statistikseite. Funktioniert nur mit privacy, das auf 2 gesetzt ist.
email
optional integer
Regelmässige E-Mail-Berichte. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Aktiviert.
exclude_bots
optional integer
Schliessen Sie gängige Bots von der Nachverfolgung aus. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Aktiviert.
exclude_params
optional string
Exclude URL query parameters from being tracked. Eine pro Zeile..
exclude_ips
optional string
Schliessen Sie IPs von der Nachverfolgung aus. Eine pro Zeile..
Löschen

API-Endpunkt:

DELETE 
https://analytics.kreisvier.com/api/v1/websites/{id}

Beispiel anfordern: 

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