api-referenceGET
GEThttps://analytics.flowsery.com/analytics/api/v1/countries

Analysedaten segmentiert nach Land 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

ParameterTypBeschreibung
websiteIdstringWebsite-ID zur Verwendung mit einem Workspace-API-Token. Bei der Authentifizierung mit einem Website-API-Schlüssel weglassen.
domainstringWebsite domain zur Verwendung mit einem Workspace-API-Token, wenn websiteId nicht bereitgestellt wird. Bei der Authentifizierung mit einem Website-API-Schlüssel weglassen.

Abfrageparameter

ParameterTypBeschreibung
startAtstringISO 8601-Startdatum/-uhrzeit (z. B. 2024-01-01T00:00:00Z). Wenn weggelassen, werden standardmäßig die letzten 30 Tage verwendet.
endAtstringDatum/Uhrzeit des ISO 8601-Endes. Wird standardmäßig auf „jetzt“ gesetzt, wenn es weggelassen wird.
timezonestringZeitzone fuer die Aggregation (z. B. UTC, America/New_York). Faellt auf die konfigurierte Zeitzone der Website zurueck.
limitnumberMaximale Anzahl zurueckgegebener Zeilen (1-1000, Standard: 100).
offsetnumberZu ueberspringende Zeilen fuer Paginierung (min. 0, Standard: 0).

Filterparameter

ParameterTypBeschreibung
filter_countrystringLändername, wie /countries ihn liefert, z. B. United States. Verwenden Sie | für mehrere Werte, ! zum Ausschließen und ~ für einen Teiltreffer.
filter_regionstringName der Region oder des Bundesstaats, wie /regions ihn liefert, z. B. California.
filter_citystringStadtname.
filter_devicestringGerätetyp: Desktop, Mobile oder Tablet. Groß- und Kleinschreibung zählt.
filter_browserstringBrowsername. Safari schliesst Mobile Safari automatisch ein.
filter_osstringBetriebssystem (Mac OS, Windows, iOS, Android).
filter_referrerstringReferrer, wie /referrers ihn liefert: ein Quellenname wie Google für bekannte Seiten, sonst die Domain.
filter_refstringDer ref-URL-Parameterwert.
filter_sourcestringDer source-URL-Parameterwert.
filter_viastringDer via-URL-Parameterwert.
filter_utm_sourcestringUTM-Quelle.
filter_utm_mediumstringUTM-Medium.
filter_utm_campaignstringUTM-Kampagne.
filter_utm_termstringUTM-Begriff.
filter_utm_contentstringUTM-Inhalt.
filter_pagestringSeitenpfad oder URL.
filter_entry_pagestringEinstiegsseiten-Pfad oder URL.
filter_hostnamestringHostname/Domain.
filter_channelstringMarketingkanal.
filter_goalstringZielname.

Antwortfelder

Jedes Element im Array <code>data</code> enthält den Ländernamen in <code>value</code>, den <code>countryCode</code> nach ISO 3166-1 Alpha-2, 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|Canada&filter_device=Mobile</code>).
Beispielanfrage (curl)
curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/countries?limit=5' \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "value": "United States",
      "countryCode": "US",
      "visitors": 2840,
      "revenue": 6780,
      "newRevenue": 5040,
      "renewalRevenue": 1740,
      "percentage": 44.1
    },
    {
      "value": "France",
      "countryCode": "FR",
      "visitors": 1230,
      "revenue": 2450,
      "newRevenue": 1920,
      "renewalRevenue": 530,
      "percentage": 19.1
    },
    {
      "value": "United Kingdom",
      "countryCode": "GB",
      "visitors": 920,
      "revenue": 1450,
      "newRevenue": 1130,
      "renewalRevenue": 320,
      "percentage": 14.3
    },
    {
      "value": "Germany",
      "countryCode": "DE",
      "visitors": 780,
      "revenue": 1230,
      "newRevenue": 1020,
      "renewalRevenue": 210,
      "percentage": 12.1
    },
    {
      "value": "Spain",
      "countryCode": "ES",
      "visitors": 650,
      "revenue": 980,
      "newRevenue": 840,
      "renewalRevenue": 140,
      "percentage": 10.1
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 148
  }
}