Groups conversations into a 7×24 grid (day-of-week × hour) so workforce planners can schedule shifts to match demand. The default range is 30 days. CSV export is available with `format=csv` on Pro and Enterprise plans. 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/busiest-heatmapOrganization 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
{
"data": [
{
"dayOfWeek": 1,
"hour": 14,
"count": 42
}
]
}{
"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/busiest-heatmap?format=json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'const response = await fetch("https://api.convor.io/api/analytics/busiest-heatmap?format=json", {
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 conversation sentiment trends
Returns the latest successful unified AI analysis for each conversation in the selected period. Repeated snapshots of the same conversation are deduplicated, so active-analysis frequency does not inflate the distribution. The JSON response includes daily averages and overall distribution; `format=csv` exports one row per day. 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 conversation volume by hour-of-day
Groups conversations by the hour they were created so teams can see when traffic is highest. The default range is 30 days. `conversationsPerOperator` returns the same value as `count` in this response. CSV export is available with `format=csv` on Pro and Enterprise plans. 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.