Get details on a specific SLA violation

client.slas.retrieveViolation(, , ?): SlaRetrieveViolationResponse { allowable_downtime_hours, data_source, data_source_type, 8 more }

GET/v1/slas/{sla_urn}/violations/{violation_urn}

ParametersExpand Collapse

violationUrn: string

params: SlaRetrieveViolationParams { sla_urn }

sla_urn: string

ReturnsExpand Collapse

SlaRetrieveViolationResponse { allowable_downtime_hours, data_source, data_source_type, 8 more }

allowable_downtime_hours: number

The total number of allowable downtime hours during the evaluation period, as defined by the SLA's terms

data_source: APIStatusPageSlaDataSource { excluded_product_tags, included_product_tags, urn, data_source_type } | APIMonitorSlaDataSource { description, name, urn, data_source_type }

The data source used to determine the violation.

Accepts one of the following:

APIStatusPageSlaDataSource { excluded_product_tags, included_product_tags, urn, data_source_type }

excluded_product_tags: Array<string>

A list of incident tags that are excluded from the SLA's calculations

included_product_tags: Array<string>

A list of incident tags that are included in the SLA's calculations

urn: string

A unique identifier for the data source

data_source_type?: "STATUS_PAGE"

The type of the data source

APIMonitorSlaDataSource { description, name, urn, data_source_type }

description: string | null

The monitor's description

The monitor's display name

urn: string

A unique identifier for the data source

data_source_type?: "MONITOR"

The type of the data source

data_source_type: "STATUS_PAGE" | "MONITOR"

The type of data source used to determine the violation.

Accepts one of the following:

"STATUS_PAGE"

"MONITOR"

data_source_urn: string

The unique identifier of the data source used to determine the violation

downtime_events: Array<DowntimeEvent>

A list of downtime events that occurred during the evaluation period and contributed to the SLA violation

duration_hours: number

The duration of the downtime event in hours

end_time: string

The end time of the downtime event

formatdate-time

The display name of the downtime event

start_time: string

The start time of the downtime event

formatdate-time

downtime_hours: number

The total number of downtime hours during the evaluation period

evaluation_period: EvaluationPeriod { end_month, start_month }

The evaluation period during which the SLA violation occurred. The length of the period is determined by the SLA's configured evaluation window (for example: monthly or quarterly).

end_month: EndMonth { month, year }

The month in which the SLA violation ended. Null if the violation is ongoing.

month: number

The month number (1-12)

year: number

The year of the month

start_month: StartMonth { month, year }

The month in which the SLA violation started

month: number

The month number (1-12)

year: number

The year of the month

sla: Sla { description, name, urn, vendor_urn }

The SLA that was violated

description: string

A description of the SLA

The name of the SLA

urn: string

A unique identifier for the SLA

vendor_urn: string

A unique identifier for the vendor associated with the SLA

uptime_percentage: number

The percentage of uptime during the evaluation period

urn: string

A unique identifier composed of the SLA URN and the evaluation period

vendor: Vendor { created_at, description, name, urn }

The vendor responsible for the violation

created_at: string

An ISO-8601-formatted timestamp representing when the vendor was created (UTC)

formatdate-time

description: string | null

The vendor's description

The vendor's display name

urn: string

A unique identifier for the vendor

Get details on a specific SLA violation

import Clarative from 'clarative';

const client = new Clarative({
  apiKey: process.env['CLARATIVE_API_KEY'], // This is the default and can be omitted
});

const response = await client.slas.retrieveViolation('violation_urn', { sla_urn: 'sla_urn' });

console.log(response.allowable_downtime_hours);

{
  "allowable_downtime_hours": 0,
  "data_source": {
    "excluded_product_tags": [
      "string"
    ],
    "included_product_tags": [
      "string"
    ],
    "urn": "urn",
    "data_source_type": "STATUS_PAGE"
  },
  "data_source_type": "STATUS_PAGE",
  "data_source_urn": "data_source_urn",
  "downtime_events": [
    {
      "duration_hours": 0,
      "end_time": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "start_time": "2019-12-27T18:11:19.117Z"
    }
  ],
  "downtime_hours": 0,
  "evaluation_period": {
    "end_month": {
      "month": 0,
      "year": 0
    },
    "start_month": {
      "month": 0,
      "year": 0
    }
  },
  "sla": {
    "description": "description",
    "name": "name",
    "urn": "urn",
    "vendor_urn": "vendor_urn"
  },
  "uptime_percentage": 0,
  "urn": "urn",
  "vendor": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "urn": "urn"
  }
}

Returns Examples

{
  "allowable_downtime_hours": 0,
  "data_source": {
    "excluded_product_tags": [
      "string"
    ],
    "included_product_tags": [
      "string"
    ],
    "urn": "urn",
    "data_source_type": "STATUS_PAGE"
  },
  "data_source_type": "STATUS_PAGE",
  "data_source_urn": "data_source_urn",
  "downtime_events": [
    {
      "duration_hours": 0,
      "end_time": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "start_time": "2019-12-27T18:11:19.117Z"
    }
  ],
  "downtime_hours": 0,
  "evaluation_period": {
    "end_month": {
      "month": 0,
      "year": 0
    },
    "start_month": {
      "month": 0,
      "year": 0
    }
  },
  "sla": {
    "description": "description",
    "name": "name",
    "urn": "urn",
    "vendor_urn": "vendor_urn"
  },
  "uptime_percentage": 0,
  "urn": "urn",
  "vendor": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "urn": "urn"
  }
}