api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/regionsPobiera 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
| 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 |
|---|---|---|
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). |
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 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
}
}