Returns visitor totals, online visitor count, new-versus-returning counts, and top countries for the requested period. `period` defaults to `24h` and accepts `24h`, `7d`, or `30d`. `onlineNow` counts visitors seen in the last five minutes. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `visitors:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Statistics are calculated for the authenticated organization and can lag recent write-side events while asynchronous analytics are being processed. Retry behavior: This read-only operation is safe to retry.
/api/visitors/statsOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"total": 120,
"onlineNow": 8,
"newVsReturning": {
"new": 45,
"returning": 75
},
"topCountries": [
{
"country": "US",
"count": 60
},
{
"country": "PL",
"count": 20
}
],
"period": "7d",
"nextOnlineExpiryInSeconds": 180
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request GET \
'https://api.convor.io/api/visitors/stats' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'const response = await fetch("https://api.convor.io/api/visitors/stats", {
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 visitor by ID
Returns the full visitor record, including browser details, page history, and selected metadata-derived fields. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `visitors:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Retry behavior: This read-only operation is safe to retry.
List visitors
Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range. When both page and offset are sent, page takes precedence. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `visitors:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Use the returned pagination metadata rather than inferring another page from the item count. Filters and search are evaluated only against visitors in the authenticated organization. Retry behavior: This read-only operation is safe to retry.