DataFast logoDataFast
"Best analytics tool I've used in 14 years"

Get realtime map

GET https://datafa.st/api/v1/analytics/realtime/map

Return active visitors with location and device data, plus recent goal events and payments for the realtime map. Each visitor may include conversion prediction scores when enough revenue attribution data exists.

Active visitors are those with pageview activity in the last 10 minutes. Customers receive a prediction score of 100.

Request

Query parameters

websiteId
string
Required with a dft_ account token on Website API routes. Omit with a df_ website key. Example: ?websiteId=665f0b3c4d2e1a0012345678.

Response

Returns a JSON object with status: "success" and endpoint-specific fields in data (and pagination when the endpoint is paginated).

Response fields

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.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.

Authentication

  • df_ website API key: The website is inferred from the key. You do not need a websiteId query parameter.
  • dft_ account token: Requires analytics:read permission and ?websiteId= on every request. The token must be allowed to access that website.
Read authentication and scopes for token creation, permission lists, and scoped tokens.

Errors

404 — Website not found.

See API errors for the standard error envelope, auth failures, validation errors, permission errors, and rate limits.

✍️ Something missing? Suggest features.

🤖 AI agent or LLM? Read this page as markdown

Example request
curl -X GET "https://datafa.st/api/v1/analytics/realtime/map" \
  -H "Authorization: Bearer df_xxx"
Success response
{
  "status": "success",
  "data": {
    "count": 2,
    "visitors": [{
      "visitorId": "a3ab2331-989f-4cfa-91c6-2461c9e3c6bd",
      "location": {
        "city": "Paris",
        "countryCode": "FR"
      },
      "system": {
        "browser": "Chrome",
        "device": "desktop"
      },
      "currentUrl": "/pricing"
    }],
    "hasConversionPredictions": false,
    "recentEvents": [],
    "recentPayments": []
  }
}
PreviousAPI reference / RealtimeNextAPI reference / Breakdowns