Website-Übersicht abrufen

api-referenceGET

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

Aggregierte Analysemetriken fuer Ihre Website 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. 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`	IANA-Zeitzonen-Kennung. Faellt auf die konfigurierte Zeitzone der Website zurueck.

Filterparameter

Parameter	Typ	Beschreibung
`filter_country`	`string`	Ländername, wie /countries ihn liefert, z. B. United States. Verwenden Sie \| für mehrere Werte, ! zum Ausschließen und ~ für einen Teiltreffer.
`filter_region`	`string`	Name der Region oder des Bundesstaats, wie /regions ihn liefert, z. B. California.
`filter_city`	`string`	Stadtname.
`filter_device`	`string`	Gerätetyp: Desktop, Mobile oder Tablet. Groß- und Kleinschreibung zählt.
`filter_browser`	`string`	Browsername (Chrome, Safari, Firefox, Edge). Safari schliesst Mobile Safari automatisch ein.
`filter_os`	`string`	Betriebssystem (Mac OS, Windows, iOS, Android).
`filter_referrer`	`string`	Referrer, wie /referrers ihn liefert: ein Quellenname wie Google für bekannte Seiten, sonst die Domain.
`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.

Hinweise

Ohne Datumsbereich nutzt die API die letzten 30 Tage bis jetzt. bounceRate und conversionRate sind Prozentwerte, avgSessionDuration und avgEngagedTime sind Sekunden. Filterwerte akzeptieren | für mehrere Werte, ! zum Ausschließen und ~ für einen Teiltreffer.

Beispielanfrage (curl)

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

200

{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890,
      "bounceRate": 65.32,
      "avgSessionDuration": 246,
      "avgEngagedTime": 187,
      "revenue": 28450,
      "renewalRevenue": 6320,
      "refundedRevenue": 410,
      "revenuePerVisitor": 2.29,
      "conversionRate": 1.15,
      "kpiValue": 28450,
      "kpiPerVisitor": 2.29,
      "kpiConversionRate": 1.15,
      "currency": "USD"
    }
  ]
}