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

Grupuje odwiedzających według dowolnego z 25 wymiarów, także tych bez osobnego punktu końcowego, takich jak entry_page, exit_link, browser_version, os_version, via i poszczególne parametry UTM.

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
dimensionWYMAGANEstringAtrybut grupowania odwiedzających: jedna z 25 wartości wymienionych w sekcji Wymiary. Każda inna zwraca 400.
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).

Wymiary

ParametrTypOpis
devicestringTyp urządzenia: Desktop, Mobile lub Tablet.
pagestringŚcieżka strony.
entry_pagestringPierwsza strona sesji.
exit_linkstringLink wychodzący kliknięty przy opuszczaniu witryny. Przychód zawsze wynosi 0.
hostnamestringHost, z którego podano stronę.
referrerstringNazwa źródła odesłania, np. Google, lub domena w przypadku witryn nierozpoznanych przez Flowsery. Wiersze zawierają iconUrl.
channelstringKanał pozyskania, te same wiersze co w GET /channels.
campaignstringKampania UTM, te same wiersze co w GET /campaigns.
goalstringNazwa celu. visitors zawiera liczbę realizacji, a przychód zawsze wynosi 0.
countrystringNazwa kraju. Wiersze zawierają countryCode.
regionstringPełna nazwa regionu lub stanu, np. California. Wiersze zawierają countryCode.
citystringNazwa miasta. Wiersze zawierają countryCode.
browserstringNazwa przeglądarki.
browser_versionstringWersja przeglądarki.
osstringSystem operacyjny.
os_versionstringWersja systemu operacyjnego.
utm_sourcestringParametr URL utm_source.
utm_mediumstringParametr URL utm_medium.
utm_campaignstringParametr URL utm_campaign.
utm_termstringParametr URL utm_term.
utm_contentstringParametr URL utm_content.
refstringParametr URL ref.
sourcestringParametr URL source.
viastringParametr URL via, często używany w linkach afiliacyjnych i partnerskich.
all_paramsstringWszystkie parametry śledzenia sesji połączone w jedną wartość, np. utm_source=google&utm_medium=cpc.

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 grupowaną wartość jako value, liczbę odwiedzających, przychód podzielony na newRevenue i renewalRevenue oraz udział w odwiedzających jako percentage. Wymiary geograficzne dodają countryCode, a referrer dodaje iconUrl. Wartość, której nie zarejestrowano, wraca jako Unknown.

Wartości pasują do filtrów

Wartości wracają w formacie oczekiwanym przez parametry filter_*, więc każdy wiersz można odesłać jako filtr. Regiony to pełne nazwy (California, nie CA), urządzenia zaczynają się wielką literą (Desktop, Mobile, Tablet), a źródła odesłań to nazwy źródeł (Google, nie google.com).

Łączenie filtrów

Kilka wartości w jednym parametrze filtra rozdziela się znakiem |. Połączenie wymiaru z filtrami pozwala odpowiadać na węższe pytania (np. dimension=via&filter_country=United States&filter_device=Mobile).
Przykładowe żądanie (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
  }
}