Hostname-Analysedaten abrufen

api-referenceGET

GEThttps://analytics.flowsery.com/analytics/api/v1/hostnames

Analysedaten segmentiert nach Hostname abrufen.

Bearer-Token (Workspace-Token oder Website-API-Schlüssel)

Workspace-Tokens benötigen einen Website-Selektor

Workspace-API-Tokens können auf jede Website im Workspace zugreifen. Übergeben Sie entweder <code>websiteId</code> oder <code>domain</code>, damit Flowsery weiß, welche Website abgefragt oder geändert werden muss. Website-API-Schlüssel sind bereits auf eine Website beschränkt, sodass der Selektor weggelassen werden kann.

Website-Auswahl

Parameter	Typ	Beschreibung
`websiteId`	`string`	Website-ID zur Verwendung mit einem Workspace-API-Token. Bei der Authentifizierung mit einem Website-API-Schlüssel weglassen.
`domain`	`string`	Website domain zur Verwendung mit einem Workspace-API-Token, wenn websiteId nicht bereitgestellt wird. Bei der Authentifizierung mit einem Website-API-Schlüssel weglassen.

Abfrageparameter

Parameter	Typ	Beschreibung
`startAt`	`string`	ISO 8601-Startdatum/-uhrzeit (z. B. 2024-01-01T00:00:00Z). Wenn weggelassen, werden standardmäßig die letzten 30 Tage verwendet.
`endAt`	`string`	Datum/Uhrzeit des ISO 8601-Endes. Wird standardmäßig auf „jetzt“ gesetzt, wenn es weggelassen wird.
`timezone`	`string`	Zeitzone fuer die Aggregation (z. B. UTC, America/New_York). Faellt auf die konfigurierte Zeitzone der Website zurueck.
`limit`	`number`	Maximale Anzahl zurueckgegebener Zeilen (1-1000, Standard: 100).
`offset`	`number`	Zu ueberspringende Zeilen fuer Paginierung (min. 0, Standard: 0).

Filterparameter

Parameter	Typ	Beschreibung
`filter_country`	`string`	Ländername oder -code. Verwenden Sie \| für mehrere Werte und! auszuschließen.
`filter_region`	`string`	Region oder Bundesland.
`filter_city`	`string`	Stadtname.
`filter_device`	`string`	Gerätetyp. Verwenden Sie Backend-Werte wie Desktop\|Mobile\|Tablet und! auszuschließen.
`filter_browser`	`string`	Browsername. Safari schliesst Mobile Safari automatisch ein.
`filter_os`	`string`	Betriebssystem (Mac OS, Windows, iOS, Android).
`filter_referrer`	`string`	Referrer-Domain oder bekannter Name.
`filter_ref`	`string`	Der ref-URL-Parameterwert.
`filter_source`	`string`	Der source-URL-Parameterwert.
`filter_via`	`string`	Der via-URL-Parameterwert.
`filter_utm_source`	`string`	UTM-Quelle.
`filter_utm_medium`	`string`	UTM-Medium.
`filter_utm_campaign`	`string`	UTM-Kampagne.
`filter_utm_term`	`string`	UTM-Begriff.
`filter_utm_content`	`string`	UTM-Inhalt.
`filter_page`	`string`	Seitenpfad oder URL.
`filter_entry_page`	`string`	Einstiegsseiten-Pfad oder URL.
`filter_hostname`	`string`	Hostname/Domain.
`filter_channel`	`string`	Marketingkanal.
`filter_goal`	`string`	Zielname.

Antwortfelder

Jedes Element im <code>data</code>-Array enthaelt den Hostnamen, die Besucherzahl und den diesem Hostnamen zugeordneten Umsatz. Nuetzlich fuer Websites, die Traffic ueber mehrere Domains oder Subdomains bereitstellen.

Filter kombinieren

Uebergeben Sie kommagetrennte Werte innerhalb eines einzelnen Filterparameters, um mehrere Eintraege abzugleichen. Kombinieren Sie verschiedene Filterparameter, um die Ergebnisse weiter einzugrenzen (z. B. <code>filter_hostname=example.com&filter_country=United States</code>).

Beispielanfrage (curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/hostnames' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "example.com",
      "visitors": 15240,
      "revenue": 24560,
      "renewalRevenue": 6120,
      "percentage": 100
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 1
  }
}