api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/visitors/{visitorId}Pobiera dane o tożsamości, aktywności, przychodach i profilu odwiedzającego na podstawie wewnętrznego visitorId zwracanego przez Flowsery.
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. |
Identyfikacja odwiedzającego
Należy użyć wewnętrznego visitorId z rekordów Flowsery lub odpowiedzi API. Nie należy przekazywać cookie przeglądarki _fs_vid bezpośrednio jako parametru ścieżki.Pola odpowiedzi
| Parametr | Typ | Opis |
|---|---|---|
identity | object | Lokalizacja, typ urządzenia, przeglądarka, system i wymiary okna z ostatniej odsłony |
source | string | null | Pierwotne źródło ruchu, z którego przyszedł odwiedzający (domena odsyłająca lub źródło UTM) |
sourceIconUrl | string | null | Adres URL favikony źródła ruchu |
activity | object | Liczba wizyt i odsłon, dane o czasie, ostatni URL, zrealizowane cele i lista odwiedzonych stron |
revenue | object | Podsumowanie przychodów: totalRevenue, flaga isCustomer, timeToFirstConversion (sekundy lub null) |
profile | object | null | Dane zidentyfikowanego użytkownika (userId, name, email), jeśli wywołano identify. Null dla anonimowych odwiedzających |
activityTimeline | array | Połączona chronologiczna lista odsłon, realizacji celów i płatności tego odwiedzającego |
Przykładowe żądanie (Curl)
curl --request GET \
--url https://analytics.flowsery.com/analytics/api/v1/visitors/{visitorId} \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": {
"visitorId": "a3ab2331-989f-4cfa-91c6-2461c9e3c6bd",
"identity": {
"country": "South Korea",
"countryCode": "KR",
"region": "KR-44",
"city": "Seosan City",
"browser": { "name": "Chrome", "version": "133.0.0.0" },
"os": { "name": "Mac OS", "version": "10.15.7" },
"device": { "type": "Desktop" },
"viewport": { "width": 1728, "height": 998 }
},
"source": "youtube.com",
"sourceIconUrl": "https://icons.duckduckgo.com/ip3/youtube.com.ico",
"activity": {
"visitCount": 3,
"pageViewCount": 8,
"firstVisitAt": "2025-04-11T03:38:49.154Z",
"lastVisitAt": "2025-04-11T03:38:49.154Z",
"currentUrl": "example.com/",
"visitedPages": [
{ "url": "example.com/", "timestamp": "2025-04-11T03:38:49.154Z" }
],
"completedCustomGoals": [
{ "name": "newsletter_signup", "timestamp": "2025-04-11T03:38:54.253Z" }
]
},
"revenue": {
"totalRevenue": 29.99,
"isCustomer": true,
"timeToFirstConversion": 3600
},
"profile": {
"userId": "usr_123",
"name": "John Doe",
"email": "john@example.com"
},
"activityTimeline": [
{
"type": "payment",
"timestamp": "2025-04-11T04:38:49.154Z",
"url": null,
"eventName": null,
"amount": 29.99
},
{
"type": "goal",
"timestamp": "2025-04-11T03:38:54.253Z",
"url": null,
"eventName": "newsletter_signup",
"amount": null
},
{
"type": "pageview",
"timestamp": "2025-04-11T03:38:49.154Z",
"url": "example.com/",
"eventName": null,
"amount": null
}
]
}
}