Get realtime map
GET https://datafa.st/api/v1/analytics/realtime/map
Return active visitors, recent events, recent payments, and prediction data for realtime map views.
Request
Authentication
df_website API key for one website.dft_account token withanalytics:read. PasswebsiteIdas a query parameter.
Response
Returns a JSON object with
status and endpoint-specific fields.Response fields
| Field | Type | Description |
|---|---|---|
data.count | number | Number of currently active visitors in the realtime window. |
data.visitors | object[] | Number of unique visitors represented by this row or time bucket. Use it to compare traffic volume across dates, pages, sources, countries, devices, or campaigns. Active visitor records used to draw the realtime map/list. |
data.visitors[].visitorId | string | Alias for datafast_visitor_id on endpoints that accept both names. |
data.visitors[].location | object | Location used to place the visitor on the map. |
data.visitors[].location.city | string | null |
data.visitors[].location.region | string | null |
data.visitors[].location.countryCode | string | null |
data.visitors[].system | object | Browser, OS, and device values for the active visitor. |
data.visitors[].system.browser | string | null |
data.visitors[].system.os | string | null |
data.visitors[].system.device | string | null |
data.visitors[].currentUrl | string | null |
data.visitors[].profileData | object | Identify profile display data. |
data.visitors[].conversionLikelihood | object | null |
data.conversionMetrics | object | Baseline conversion metrics used for predictions. |
data.hasConversionPredictions | boolean | Whether prediction fields are available. |
data.recentEvents | object[] | Recent goal/custom events shown in realtime UI. |
data.recentPayments | object[] | Recent payment events shown in realtime UI. |
Errors
Common errors include
400 for invalid input, 401 for missing or invalid tokens, 403 for missing permission or suspended tracking, 404 for missing resources, and 500 for server errors.