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

Pobiera dane analityczne według regionu.

Bearer Token (token obszaru roboczego lub klucz API witryny)

Tokeny obszaru roboczego wymagają wskazania witryny

Tokeny API obszaru roboczego mają dostęp do wszystkich witryn w obszarze. Należy przekazać websiteId lub domain, aby Flowsery wiedziało, której witryny dotyczy zapytanie lub zmiana. Klucze API witryn są już przypisane do jednej witryny, więc można to pominąć.

Wskazanie witryny

ParametrTypOpis
websiteIdstringID witryny używane z tokenem API obszaru roboczego. Należy pominąć przy uwierzytelnianiu kluczem API witryny.
domainstringDomena witryny używana z tokenem API obszaru roboczego, gdy nie podano websiteId. Należy pominąć przy uwierzytelnianiu kluczem API witryny.

Parametry zapytania

ParametrTypOpis
startAtstringData i godzina początku w ISO 8601 (np. 2024-01-01T00:00:00Z). Po pominięciu: ostatnie 30 dni.
endAtstringData i godzina końca w ISO 8601. Po pominięciu: teraz.
timezonestringStrefa czasowa agregacji (np. UTC, America/New_York). Domyślnie strefa skonfigurowana dla witryny.
limitnumberMaksymalna liczba zwracanych wierszy (1-1000, domyślnie: 100).
offsetnumberLiczba wierszy do pominięcia przy paginacji (min. 0, domyślnie: 0).

Parametry filtrowania

ParametrTypOpis
filter_countrystringNazwa kraju zwracana przez /countries, np. United States. | rozdziela kilka wartości, ! wyklucza, a ~ dopasowuje fragment wartości.
filter_regionstringNazwa regionu lub stanu zwracana przez /regions, np. California.
filter_citystringNazwa miasta.
filter_devicestringTyp urządzenia: Desktop, Mobile lub Tablet. Wielkość liter ma znaczenie.
filter_browserstringNazwa przeglądarki. Safari automatycznie obejmuje Mobile Safari.
filter_osstringSystem operacyjny (Mac OS, Windows, iOS, Android).
filter_referrerstringŹródło odesłania zwracane przez /referrers: nazwa źródła, np. Google, dla rozpoznanych witryn, a w pozostałych przypadkach domena.
filter_refstringWartość parametru URL ref.
filter_sourcestringWartość parametru URL source.
filter_viastringWartość parametru URL via.
filter_utm_sourcestringŹródło UTM.
filter_utm_mediumstringMedium UTM.
filter_utm_campaignstringKampania UTM.
filter_utm_termstringTermin UTM.
filter_utm_contentstringTreść UTM.
filter_pagestringŚcieżka lub adres URL strony.
filter_entry_pagestringŚcieżka lub adres URL strony wejścia.
filter_hostnamestringHost/domena.
filter_channelstringKanał marketingowy.
filter_goalstringNazwa celu.

Pola odpowiedzi

Każdy element tablicy data zawiera nazwę regionu jako value, countryCode jego kraju, liczbę odwiedzających, przychód podzielony na newRevenue i renewalRevenue oraz udział w odwiedzających jako percentage.

Łączenie filtrów

Kilka wartości w jednym parametrze filtra rozdziela się znakiem |. Połączenie różnych parametrów filtrów dodatkowo zawęża wyniki (np. filter_country=United States&filter_region=California|Texas).
Przykładowe żądanie (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
  }
}