api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/overviewPobiera zagregowane wskaźniki analityczne witryny.
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. Po pominięciu: ostatnie 30 dni. |
endAt | string | Data i godzina końca w ISO 8601. Po pominięciu: teraz. |
timezone | string | Identyfikator strefy czasowej IANA. Domyślnie strefa skonfigurowana dla witryny. |
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 (Chrome, Safari, Firefox, Edge). 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. |
Uwagi
Bez zakresu dat API domyślnie zwraca ostatnie 30 dni do teraz. bounceRate i conversionRate to wartości procentowe, a avgSessionDuration i avgEngagedTime są w sekundach. Wartości filtrów przyjmują | dla kilku wartości, ! do wykluczenia i ~ do dopasowania fragmentu wartości.Przykładowe żądanie (Curl)
curl --request GET \
--url https://analytics.flowsery.com/analytics/api/v1/overview \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"visitors": 12450,
"sessions": 16890,
"bounceRate": 65.32,
"avgSessionDuration": 246,
"avgEngagedTime": 187,
"revenue": 28450,
"renewalRevenue": 6320,
"refundedRevenue": 410,
"revenuePerVisitor": 2.29,
"conversionRate": 1.15,
"kpiValue": 28450,
"kpiPerVisitor": 2.29,
"kpiConversionRate": 1.15,
"currency": "USD"
}
]
}