---
title: "List visitors active right now with their location"
method: GET
path: "/realtime/map"
tags: ["Reports"]
---

# List visitors active right now with their location

`GET /realtime/map`

## Request

- Base URL: `https://analytics.flowsery.com/analytics/api/v1`
- URL: `https://analytics.flowsery.com/analytics/api/v1/realtime/map`
- Auth: HTTP bearer

Visitors seen in the last 5 minutes with geo, device, current page and revenue, for a live map. Capped to the 1000 most recently active visitors.

## Query parameters

- `websiteId` string
- `domain` string

## Headers

- `X-Workspace-Id` string

## Response `200`

Active visitors with location

- RealtimeMapResponse
  - `status` 'success', required
  - `data` RealtimeMapVisitor[], required
    - `visitorId` string, required
    - `visitorUid` string, nullable
    - `country` string, nullable
    - `countryCode` string, nullable
    - `region` string, nullable
    - `city` string, nullable
    - `latitude` number, nullable
    - `longitude` number, nullable
    - `browser` string, nullable
    - `os` string, nullable
    - `deviceType` 'Desktop' | 'Mobile' | 'Tablet' | 'Unknown', nullable
    - `currentUrl` string, nullable
    - `referrer` string, nullable
    - `referrerSource` string, nullable
    - `referrerIconUrl` string, nullable
    - `sessionStartTime` string, date-time, nullable
    - `pageviews` integer, required
    - `totalRevenue` number, required
    - `isCustomer` boolean, required
    - `name` string, nullable
    - `email` string, nullable

## Other responses

- `401`: Missing, invalid, expired or revoked API key or access token. `code: token_issuer_lost_access` means the member who created the API key was deactivated or lost access to the workspace: ask a workspace admin for a new key
- `403`: The credentials are valid but cannot be used here. `code: permission_denied`: the workspace role behind the API key or OAuth sign-in lacks `flowsery.write`; `role`, `keyRole` and `issuerRole` say which role fell short. `code: subscription_required`: the organization plan does not include API access. `code: workspace_access_denied`: `X-Workspace-Id` names a workspace the caller cannot reach, or an API key was sent to a workspace other than its own
- `404`: Website not found
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api.md) · [All operations](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api/revisions/8f23583fdf0e?raw)