Returns SLA breach totals for the selected date range together with a daily trend, per-metric counts, and per-policy totals.

GET/api/analytics/sla-breach-trend

Returns SLA breach totals for the selected date range together with a daily trend, per-metric counts, and per-policy totals. The report reads from the in-memory breach store and includes only breaches recorded since the current server process started. To use custom dates, send both start and end as ISO 8601 datetimes with offsets. Explicit boundaries override range; a single boundary is rejected. Date buckets are calculated in UTC. Periods with no data return the documented empty or zero-value response. Endpoints that support format=csv return a text/csv download. CSV export may require an eligible plan; JSON is the default.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: analytics:read
Module: Automation & API module (automation_api)
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

range?string

Query parameter. Range. Allowed values: 7d, 30d, 90d.

start?string

Query parameter. ISO 8601 date and time for start.

end?string

Query parameter. ISO 8601 date and time for end.

format?string

Query parameter. Format. Allowed values: json, csv.

Response Body

`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"
  }
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/analytics/sla-breach-trend?format=json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

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 SLA breach trend with per-metric and per-policy breakdown

Returns SLA breach totals for the selected date range together with a daily trend, per-metric counts, and per-policy totals.

GET/api/analytics/sla-breach-trend

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: analytics:read
Module: Automation & API module (automation_api)
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

range?string

Query parameter. Range. Allowed values: 7d, 30d, 90d.

start?string

Query parameter. ISO 8601 date and time for start.

end?string

Query parameter. ISO 8601 date and time for end.

format?string

Query parameter. Format. Allowed values: json, csv.

Response Body

`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"
  }
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/analytics/sla-breach-trend?format=json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

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 SLA breach trend with per-metric and per-policy breakdown

Endpoint requirements

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Get daily SLA breach trend with per-metric and per-policy breakdown

Endpoint requirements

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Get daily SLA breach trend with per-metric and per-policy breakdown

Endpoint requirements

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Get daily SLA breach trend with per-metric and per-policy breakdown

Endpoint requirements

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`