Aufschlüsselung nach beliebiger Dimension abrufen

api-referenceGET

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

Besucher nach einer von 25 Dimensionen gruppieren, auch nach solchen ohne eigenen Endpunkt wie entry_page, exit_link, browser_version, os_version, via und den einzelnen UTM-Parametern.

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 websiteId oder domain, 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
`dimension`ERFORDERLICH	`string`	Das Attribut, nach dem Besucher gruppiert werden: einer der 25 Werte unter Dimensionen. Jeder andere Wert liefert 400.
`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 für die Aggregation (z. B. UTC, America/New_York). Fällt auf die konfigurierte Zeitzone der Website zurück.
`limit`	`number`	Maximale Anzahl zurückgegebener Zeilen (1-1000, Standard: 100).
`offset`	`number`	Zu überspringende Zeilen für Paginierung (min. 0, Standard: 0).

Dimensionen

Parameter	Typ	Beschreibung
`device`	`string`	Gerätetyp: Desktop, Mobile oder Tablet.
`page`	`string`	Seitenpfad.
`entry_page`	`string`	Erste Seite der Sitzung.
`exit_link`	`string`	Ausgehender Link, über den ein Besucher die Website verlassen hat. Der Umsatz ist immer 0.
`hostname`	`string`	Hostname, von dem die Seite ausgeliefert wurde.
`referrer`	`string`	Name der verweisenden Quelle wie Google, oder die Domain bei Websites, die Flowsery nicht erkennt. Zeilen enthalten iconUrl.
`channel`	`string`	Akquisitionskanal, dieselben Zeilen wie GET /channels.
`campaign`	`string`	UTM-Kampagne, dieselben Zeilen wie GET /campaigns.
`goal`	`string`	Zielname. visitors enthält die Anzahl der Abschlüsse, der Umsatz ist immer 0.
`country`	`string`	Ländername. Zeilen enthalten countryCode.
`region`	`string`	Region oder Bundesstaat als vollständiger Name, z. B. California. Zeilen enthalten countryCode.
`city`	`string`	Stadtname. Zeilen enthalten countryCode.
`browser`	`string`	Browsername.
`browser_version`	`string`	Browserversion.
`os`	`string`	Betriebssystem.
`os_version`	`string`	Betriebssystemversion.
`utm_source`	`string`	Der URL-Parameter utm_source.
`utm_medium`	`string`	Der URL-Parameter utm_medium.
`utm_campaign`	`string`	Der URL-Parameter utm_campaign.
`utm_term`	`string`	Der URL-Parameter utm_term.
`utm_content`	`string`	Der URL-Parameter utm_content.
`ref`	`string`	Der URL-Parameter ref.
`source`	`string`	Der URL-Parameter source.
`via`	`string`	Der URL-Parameter via, oft für Affiliate- und Partnerlinks genutzt.
`all_params`	`string`	Alle Tracking-Parameter der Sitzung zu einem Wert verbunden, z. B. utm_source=google&utm_medium=cpc.

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. Safari schließt 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.

Antwortfelder

Jedes Element im Array data enthält den gruppierten Wert als value, die Anzahl der Besucher, den Umsatz aufgeteilt in newRevenue und renewalRevenue sowie den Anteil an den Besuchern als percentage. Geografische Dimensionen ergänzen countryCode, referrer ergänzt iconUrl. Ein nicht erfasster Wert wird als Unknown zurückgegeben.

Werte passen zu den Filtern

Die Werte kommen in der Form zurück, die die Parameter filter_* erwarten, sodass Sie jede Zeile direkt als Filter zurückschicken können. Regionen sind vollständige Namen (California, nicht CA), Geräte beginnen mit Großbuchstaben (Desktop, Mobile, Tablet) und Referrer sind Quellennamen (Google, nicht google.com).

Filter kombinieren

Trennen Sie mehrere Werte innerhalb eines Filterparameters mit |. Kombinieren Sie eine Dimension mit Filtern, um engere Fragen zu beantworten (z. B. dimension=via&filter_country=United States&filter_device=Mobile).

Beispielanfrage (Curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/breakdown?dimension=via&limit=3' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "partner_anna",
      "visitors": 640,
      "revenue": 2310,
      "newRevenue": 1980,
      "renewalRevenue": 330,
      "percentage": 51.2
    },
    {
      "value": "partner_marc",
      "visitors": 410,
      "revenue": 1270,
      "newRevenue": 1270,
      "renewalRevenue": 0,
      "percentage": 32.8
    },
    {
      "value": "podcast",
      "visitors": 200,
      "revenue": 380,
      "newRevenue": 290,
      "renewalRevenue": 90,
      "percentage": 16
    }
  ],
  "pagination": {
    "limit": 3,
    "offset": 0,
    "total": 14
  }
}