Returns SLA breach totals for the selected date range together with a daily trend, per-metric counts, and per-policy totals. This endpoint currently reads from the in-memory breach store, so it only includes breaches recorded since the current server process started. Use `format=csv` to export the daily trend rows. 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/sla-breach-trendOrganization 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
{
"totalBreaches": 7,
"byMetric": {
"firstResponseTime": 4,
"nextResponseTime": 2,
"resolutionTime": 1
},
"byPolicy": {
"77777777-7777-4777-8777-777777777777": 5,
"88888888-8888-4888-8888-888888888888": 2
},
"trend": [
{
"date": "2026-06-20",
"count": 2
},
{
"date": "2026-06-21",
"count": 1
},
{
"date": "2026-06-23",
"count": 4
}
]
}{
"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/sla-breach-trend?format=json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'const response = await fetch("https://api.convor.io/api/analytics/sla-breach-trend?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 daily conversation volume
Returns daily conversation counts for the selected date range. When `range` is omitted, the endpoint uses the default 30-day analytics window, and `format` defaults to `json`. Setting `format=csv` streams the same dataset as a CSV export. 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 dashboard analytics summary in one request
Returns the main analytics datasets for the selected date range in one response: conversation volume, response-time trends, operator performance, visitor sources, and plan-usage counters. Use this route to populate the dashboard overview without making several separate analytics requests. The response is cached briefly because it combines several heavier analytics queries. 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.