Skip to content
Convor
Convor Docs
API ReferenceAnalytics

Get realtime visitor analytics snapshot

Returns a live dashboard snapshot covering visitors active in the last 5 minutes, open or pending conversations, operators marked online, and the most common current pages and visitor countries.

GET/api/analytics/realtime

Returns a live dashboard snapshot covering visitors active in the last 5 minutes, open or pending conversations, operators marked online, and the most common current pages and visitor countries. Realtime publications tell connected dashboards when to request a fresh snapshot. Counts are a near-real-time snapshot and can change between requests. They are not a transactional checkpoint.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
analytics:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

scope?"all"

Query parameter. Scope. Allowed values: all.

Value in

  • "all"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "activeVisitors": 19,  "activeConversations": 8,  "onlineOperators": 3,  "topPages": [    {      "page": "/pricing",      "count": 7    }  ],  "topCountries": [    {      "country": "Poland",      "count": 6    }  ],  "nextVisitorExpiryInSeconds": 180}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/analytics/realtime' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/analytics/realtime", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Get realtime queue depth and average wait time for unassigned conversations

Returns a live queue snapshot for open or pending conversations that are still unassigned.

Get SLA adherence metrics with per-operator bottleneck breakdown

Returns SLA breach counts, adherence metrics, and per-operator bottleneck analysis for the selected project scope.

On this page

Request examplescurlJavaScript