Returns visitor acquisition and browsing metrics for the selected range, which defaults to the last 30 days. The response compares new and returning visitors, lists the most common current pages, and includes a `geo` array. `geo` is returned as an empty array when country-level data is not available. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics: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. The `range` preset defaults to `30d`. To use a custom range, supply both `start` and `end` as ISO 8601 datetimes with offsets; supplying only one boundary is rejected. Explicit boundaries override the preset. Date buckets and comparisons are evaluated as absolute instants and aggregated in UTC. Empty periods return the route's documented zero or empty collection shape rather than data from another organization. Where the route exposes `format=csv`, CSV is a downloadable `text/csv` response and may require a plan with analytics export access; JSON remains the default. Retry behavior: This read-only operation is safe to retry.
/api/analytics/visitorsOrganization 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
{
"newVsReturning": [
{
"name": "New",
"value": 42
},
{
"name": "Returning",
"value": 17
}
],
"topPages": [
{
"page": "/pricing",
"views": 21
}
],
"geo": []
}{
"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/analytics/visitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'const response = await fetch("https://api.convor.io/api/analytics/visitors", {
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 top visitor sources and referrers
Returns the top visitor referrers for the selected date range. Direct traffic is grouped under `Direct`, and the response is limited to the top 10 sources. Use `format=csv` to export the same ranked source list. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics: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. The `range` preset defaults to `30d`. To use a custom range, supply both `start` and `end` as ISO 8601 datetimes with offsets; supplying only one boundary is rejected. Explicit boundaries override the preset. Date buckets and comparisons are evaluated as absolute instants and aggregated in UTC. Empty periods return the route's documented zero or empty collection shape rather than data from another organization. Where the route exposes `format=csv`, CSV is a downloadable `text/csv` response and may require a plan with analytics export access; JSON remains the default. Retry behavior: This read-only operation is safe to retry.
Get visitor sources by UTM parameters
Returns UTM source, medium, and campaign breakdowns for the selected date range. Only visitors with UTM metadata are included, and the response is limited to the top 20 rows. Use `format=csv` to export the same breakdown. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics: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. The `range` preset defaults to `30d`. To use a custom range, supply both `start` and `end` as ISO 8601 datetimes with offsets; supplying only one boundary is rejected. Explicit boundaries override the preset. Date buckets and comparisons are evaluated as absolute instants and aggregated in UTC. Empty periods return the route's documented zero or empty collection shape rather than data from another organization. Where the route exposes `format=csv`, CSV is a downloadable `text/csv` response and may require a plan with analytics export access; JSON remains the default. Retry behavior: This read-only operation is safe to retry.