Regions-Analysedaten abrufen

api-referenceGET

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

Analysedaten segmentiert nach Region 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, 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 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.

Antwortfelder

Jedes Element im Array <code>data</code> enthält den Namen der Region in <code>value</code>, den <code>countryCode</code> ihres Landes, die Besucherzahl, den Umsatz aufgeteilt in <code>newRevenue</code> und <code>renewalRevenue</code> sowie den Besucheranteil in <code>percentage</code>.

Filter kombinieren

Trennen Sie mehrere Werte innerhalb eines Filterparameters mit |. Kombinieren Sie verschiedene Filterparameter, um die Ergebnisse weiter einzugrenzen (z. B. <code>filter_country=United States&filter_region=California|Texas</code>).

Beispielanfrage (curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/regions?limit=5' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "California",
      "countryCode": "US",
      "visitors": 1150,
      "revenue": 3420,
      "newRevenue": 2640,
      "renewalRevenue": 780,
      "percentage": 33.8
    },
    {
      "value": "Ile-de-France",
      "countryCode": "FR",
      "visitors": 720,
      "revenue": 1890,
      "newRevenue": 1470,
      "renewalRevenue": 420,
      "percentage": 21.2
    },
    {
      "value": "England",
      "countryCode": "GB",
      "visitors": 540,
      "revenue": 1450,
      "newRevenue": 1190,
      "renewalRevenue": 260,
      "percentage": 15.9
    },
    {
      "value": "Berlin",
      "countryCode": "DE",
      "visitors": 480,
      "revenue": 1230,
      "newRevenue": 1030,
      "renewalRevenue": 200,
      "percentage": 14.1
    },
    {
      "value": "Madrid",
      "countryCode": "ES",
      "visitors": 510,
      "revenue": 980,
      "newRevenue": 860,
      "renewalRevenue": 120,
      "percentage": 15
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 656
  }
}