Skip to content
Convor
Convor Docs
API ReferenceSLA

List recent SLA breaches

Returns recent SLA breaches for the selected project or the caller's explicit all-project scope.

GET/api/sla/breaches

Returns recent SLA breaches for the selected project or the caller's explicit all-project scope. Results can be filtered by operator, policy, and time range, and at most 100 breaches are returned.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
sla: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"
search?string

Query parameter. Search text.

Lengthlength <= 200
metric?string

Query parameter. Metric. Allowed values: firstResponseTime, nextResponseTime, resolutionTime.

Value in

  • "firstResponseTime"
  • "nextResponseTime"
  • "resolutionTime"
page?integer

Query parameter. One-based page number.

Range1 <= value <= 9007199254740991
Default1
limit?integer

Query parameter. Maximum number of records to return.

Range1 <= value <= 100
Default25
operatorId?string

Query parameter. Unique identifier of the related operator.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
policyId?string

Query parameter. Unique identifier of the related policy.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
from?string

Query parameter. Value of from.

to?string

Query parameter. Value of to.

sortBy?string

Query parameter. Sort by. Allowed values: conversation, operator, policy, metric, breachedAt.

Default"breachedAt"

Value in

  • "conversation"
  • "operator"
  • "policy"
  • "metric"
  • "breachedAt"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Default"desc"

Value in

  • "asc"
  • "desc"

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

{  "data": [    {      "id": "breach-1",      "conversationId": "22222222-2222-4222-8222-222222222222",      "orgId": "11111111-1111-4111-8111-111111111111",      "projectId": "33333333-3333-4333-8333-333333333333",      "policyId": "77777777-7777-4777-8777-777777777777",      "policyName": "Priority support",      "breachedMetric": "firstResponseTime",      "operatorId": "44444444-4444-4444-8444-444444444444",      "operatorName": "Alice Johnson",      "breachedAt": "2026-06-23T10:00:00.000Z",      "durationSeconds": 320,      "resolvedAt": null,      "status": "open",      "acknowledgedBy": null,      "acknowledgedAt": null,      "resolvedBy": null    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 1,    "hasNextPage": false,    "hasPrevPage": false  }}

Request examples

curl

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

JavaScript

const response = await fetch("https://api.convor.io/api/sla/breaches", {
  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 SLA status overview for active conversations

Returns an aggregate SLA overview for up to the 500 most recently active open conversations in the selected project.

List SLA policies

Returns the selected project's SLA policies with server-side name search, state filter, deterministic sort and pagination.

On this page

Request examplescurlJavaScript