Websites

Anmerkungen
Expertenebene
Der API-Schlüssel sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. Ihren API-Schlüssel abrufen.
Auflisten

API-Endpunkt:

GET 
https://app.forward-visitors.io/api/v1/websites

Beispiel einer Anfrage: 

curl --location --request GET 'https://app.forward-visitors.io/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
fakultativ string
Die Suchanfrage.
search_by
fakultativ string
Suchen nach. Mögliche Werte sind: :Wert für Domain. Standardwert ist: domain.
sort_by
fakultativ string
Sort by. Mögliche Werte sind: :Wert für Date created, :Wert für Domain. Standardwert ist: id.
sort
fakultativ string
Sortieren. Mögliche Werte sind: :Wert für Absteigend, :Wert für Aufsteigend. Standardwert ist: desc.
per_page
fakultativ integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardwert ist: 25.
anzeigen

API-Endpunkt:

GET 
https://app.forward-visitors.io/api/v1/websites/{id}

Beispiel einer Anfrage: 

curl --location --request GET 'https://app.forward-visitors.io/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
speichern

API-Endpunkt:

POST 
https://app.forward-visitors.io/api/v1/websites

Beispiel einer Anfrage: 

curl --location --request POST 'https://app.forward-visitors.io/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
The domain name.
privacy
fakultativ integer
Privatsphäre der Statistikseite. Mögliche Werte sind: :Wert für Öffentlich, :Wert für Privat, :Wert für Kennwort. Standardwert ist: 1.
password
fakultativ string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
email
fakultativ integer
Regelmäßige E-Mail-Berichte. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Freigegeben. Standardwert ist: 0.
exclude_bots
fakultativ integer
Schließen Sie gewöhnliche Bots vom Tracking aus. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Freigegeben. Standardwert ist: 1.
exclude_params
fakultativ string
Exclude URL query parameters from being tracked. Eine pro Zeile..
exclude_ips
fakultativ string
Schließen Sie IPs von der Verfolgung aus. Eine pro Zeile..
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://app.forward-visitors.io/api/v1/websites/{id}

Beispiel einer Anfrage: 

curl --location --request PUT 'https://app.forward-visitors.io/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
privacy
fakultativ integer
Privatsphäre der Statistikseite. Mögliche Werte sind: :Wert für Öffentlich, :Wert für Privat, :Wert für Kennwort.
password
fakultativ string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
email
fakultativ integer
Regelmäßige E-Mail-Berichte. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Freigegeben.
exclude_bots
fakultativ integer
Schließen Sie gewöhnliche Bots vom Tracking aus. Mögliche Werte sind: :Wert für Deaktiviert, :Wert für Freigegeben.
exclude_params
fakultativ string
Exclude URL query parameters from being tracked. Eine pro Zeile..
exclude_ips
fakultativ string
Schließen Sie IPs von der Verfolgung aus. Eine pro Zeile..
Löschen

API-Endpunkt:

DELETE 
https://app.forward-visitors.io/api/v1/websites/{id}

Beispiel einer Anfrage: 

curl --location --request DELETE 'https://app.forward-visitors.io/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'