https://analytics.flowsery.com/analytics/api/v1/breakdownGrupuje 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.
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
| Parametr | Typ | Opis |
|---|---|---|
websiteId | string | ID witryny używane z tokenem API obszaru roboczego. Należy pominąć przy uwierzytelnianiu kluczem API witryny. |
domain | string | Domena witryny używana z tokenem API obszaru roboczego, gdy nie podano websiteId. Należy pominąć przy uwierzytelnianiu kluczem API witryny. |
Parametry zapytania
| Parametr | Typ | Opis |
|---|---|---|
dimensionWYMAGANE | string | Atrybut grupowania odwiedzających: jedna z 25 wartości wymienionych w sekcji Wymiary. Każda inna zwraca 400. |
startAt | string | Data i godzina początku w ISO 8601 (np. 2024-01-01T00:00:00Z). Po pominięciu: ostatnie 30 dni. |
endAt | string | Data i godzina końca w ISO 8601. Po pominięciu: teraz. |
timezone | string | Strefa czasowa agregacji (np. UTC, America/New_York). Domyślnie strefa skonfigurowana dla witryny. |
limit | number | Maksymalna liczba zwracanych wierszy (1-1000, domyślnie: 100). |
offset | number | Liczba wierszy do pominięcia przy paginacji (min. 0, domyślnie: 0). |
Wymiary
| Parametr | Typ | Opis |
|---|---|---|
device | string | Typ urządzenia: Desktop, Mobile lub Tablet. |
page | string | Ścieżka strony. |
entry_page | string | Pierwsza strona sesji. |
exit_link | string | Link wychodzący kliknięty przy opuszczaniu witryny. Przychód zawsze wynosi 0. |
hostname | string | Host, z którego podano stronę. |
referrer | string | Nazwa źródła odesłania, np. Google, lub domena w przypadku witryn nierozpoznanych przez Flowsery. Wiersze zawierają iconUrl. |
channel | string | Kanał pozyskania, te same wiersze co w GET /channels. |
campaign | string | Kampania UTM, te same wiersze co w GET /campaigns. |
goal | string | Nazwa celu. visitors zawiera liczbę realizacji, a przychód zawsze wynosi 0. |
country | string | Nazwa kraju. Wiersze zawierają countryCode. |
region | string | Pełna nazwa regionu lub stanu, np. California. Wiersze zawierają countryCode. |
city | string | Nazwa miasta. Wiersze zawierają countryCode. |
browser | string | Nazwa przeglądarki. |
browser_version | string | Wersja przeglądarki. |
os | string | System operacyjny. |
os_version | string | Wersja systemu operacyjnego. |
utm_source | string | Parametr URL utm_source. |
utm_medium | string | Parametr URL utm_medium. |
utm_campaign | string | Parametr URL utm_campaign. |
utm_term | string | Parametr URL utm_term. |
utm_content | string | Parametr URL utm_content. |
ref | string | Parametr URL ref. |
source | string | Parametr URL source. |
via | string | Parametr URL via, często używany w linkach afiliacyjnych i partnerskich. |
all_params | string | Wszystkie parametry śledzenia sesji połączone w jedną wartość, np. utm_source=google&utm_medium=cpc. |
Parametry filtrowania
| Parametr | Typ | Opis |
|---|---|---|
filter_country | string | Nazwa kraju zwracana przez /countries, np. United States. | rozdziela kilka wartości, ! wyklucza, a ~ dopasowuje fragment wartości. |
filter_region | string | Nazwa regionu lub stanu zwracana przez /regions, np. California. |
filter_city | string | Nazwa miasta. |
filter_device | string | Typ urządzenia: Desktop, Mobile lub Tablet. Wielkość liter ma znaczenie. |
filter_browser | string | Nazwa przeglądarki. Safari automatycznie obejmuje Mobile Safari. |
filter_os | string | System operacyjny (Mac OS, Windows, iOS, Android). |
filter_referrer | string | Źródło odesłania zwracane przez /referrers: nazwa źródła, np. Google, dla rozpoznanych witryn, a w pozostałych przypadkach domena. |
filter_ref | string | Wartość parametru URL ref. |
filter_source | string | Wartość parametru URL source. |
filter_via | string | Wartość parametru URL via. |
filter_utm_source | string | Źródło UTM. |
filter_utm_medium | string | Medium UTM. |
filter_utm_campaign | string | Kampania UTM. |
filter_utm_term | string | Termin UTM. |
filter_utm_content | string | Treść UTM. |
filter_page | string | Ścieżka lub adres URL strony. |
filter_entry_page | string | Ścieżka lub adres URL strony wejścia. |
filter_hostname | string | Host/domena. |
filter_channel | string | Kanał marketingowy. |
filter_goal | string | Nazwa 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 parametryfilter_*, 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).curl --request GET \
--url 'https://analytics.flowsery.com/analytics/api/v1/breakdown?dimension=via&limit=3' \
--header 'Authorization: Bearer <api-key>'{
"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
}
}