Web Chat Live Visitors

Returns the visitors on your website right now, the same list as the Live visitors table on the channel’s Overview tab and in Teambox. A visitor shows up while one of your pages with the chat snippet is open, and drops off a short while after they leave.

GET/v2.0/web-chat/channels/{channelId}/live-visitors

Scope, access and plan

Needs web_chat:read on scoped keys, web chat on for your account, and a plan that includes web chat (otherwise 403 FEATURE_NOT_ENABLED).

Privacy

Location is the country only, as a two-letter code. City, IP address and the browser’s full user agent are never returned. Visitors on sites that call Sendiee('consent', false), and every visitor when Track live visitors is off, are not listed. See Cookie banners and consent.

Path Parameters

Parameter	Type	Required	Description
channelId	string	Required	The channel id from List Web Chat Channels

Code Example

curl -X GET "https://api.sendiee.com/v2.0/web-chat/channels/6720b1c09d2b4e0011ab5501/live-visitors" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response — 200 OK

{
  "success": true,
  "data": {
    "channelId": "6720b1c09d2b4e0011ab5501",
    "tracking": true,
    "count": 2,
    "busiest": {
      "count": 9,
      "at": "2026-11-07T06:41:00.000Z"
    },
    "visitors": [
      {
        "id": "wp_q4kd7m2xa5rt3nh6vb2we7cy",
        "visitorId": "wv_m3qk7d2xr5ta6nh4vb2we7cy",
        "name": "Ananya",
        "identityLevel": "verified",
        "page": {
          "path": "/products/maroon-kanchipuram",
          "title": "Maroon Kanchipuram silk"
        },
        "onSiteSeconds": 312,
        "onPageSeconds": 48,
        "country": "IN",
        "device": "phone",
        "source": "instagram",
        "visits": 3,
        "returning": true,
        "inChat": "agent",
        "agentName": "Priya",
        "assignedAgentId": "671e9c0a9d2b4e0011ab3301",
        "conversationId": "6724c2d19d2b4e0011ab7702"
      },
      {
        "id": "wp_z2hd6k3mq7xa4rt5nb6vc2we",
        "visitorId": null,
        "name": null,
        "identityLevel": "anonymous",
        "page": {
          "path": "/",
          "title": "Kesari Loom | Handwoven sarees"
        },
        "onSiteSeconds": 41,
        "onPageSeconds": 41,
        "country": "AE",
        "device": "desktop",
        "source": "google",
        "visits": 1,
        "returning": false,
        "inChat": null,
        "agentName": null,
        "assignedAgentId": null,
        "conversationId": null
      }
    ]
  }
}

Response Fields

Parameter	Type	Required	Description
channelId	string	Optional	The channel
tracking	boolean	Optional	The channel's Track live visitors switch. When false, the list is empty
count	number	Optional	Visitors on the site now. visitors holds up to 200 of them, most recently active first
busiest	object \| null	Optional	{ count, at }: the most visitors at once today (UTC day), and when. null when nothing was recorded today
visitors[]	object[]	Optional	One row per browser on your site. See Visitor Object

Visitor Object

Parameter	Type	Required	Description
id	string	Optional	Stable id for this browser on your site (wp_…). Use it to tell rows apart between calls
visitorId	string \| null	Optional	The visitor id (wv_…) once this browser has started a chat, else null
name	string \| null	Optional	The name the visitor gave or verified, else null
identityLevel	string	Optional	anonymous, given (typed their details) or verified
page.path	string	Optional	The page they are on, path only (no query string)
page.title	string \| null	Optional	That page's title
onSiteSeconds	number	Optional	Seconds since this visit started
onPageSeconds	number	Optional	Seconds on the current page
country	string \| null	Optional	Two-letter country code, or null when unknown
device	string	Optional	phone, tablet or desktop. iPads may show as desktop
source	string	Optional	How they found you: google, bing, instagram, facebook, whatsapp, youtube, linkedin, x, email, ads, referral or direct
visits	number	Optional	How many visits this browser has made. A new visit starts after 30 minutes without activity
returning	boolean	Optional	true when they have visited before
inChat	string \| null	Optional	ai or agent when their chat had activity in the last 30 minutes, else null
agentName	string \| null	Optional	First name of the team member in the chat, when inChat is agent
assignedAgentId	string \| null	Optional	That team member's agent id, when inChat is agent
conversationId	string \| null	Optional	Their web chat conversation, if they have one. Use it with Send Message and the Teambox endpoints

Errors

403 FEATURE_NOT_ENABLED, 404 CHANNEL_NOT_FOUND and 502 UPSTREAM_ERROR, plus the errors every web chat endpoint can return.