Get uptime metrics for an SLA data source

slas.get_uptime_metrics(, ) -> SlaGetUptimeMetricsResponse

GET/v1/slas/{sla_urn}/data-sources/{data_source_urn}/uptime-metrics

ParametersExpand Collapse

sla_urn: str

data_source_urn: str

timeframe_end: Optional[str]

Year and month landing within the last SLA evaluation period to include in the result, in the format YYYY-MM

timeframe_start: Optional[str]

Year and month landing within the first SLA evaluation period to include in the result, in the format YYYY-MM

ReturnsExpand Collapse

List[SlaGetUptimeMetricsResponseItem]

data_source_urn: str

The unique identifier of the data source

downtime_events: List[SlaGetUptimeMetricsResponseItemDowntimeEvent]

A list of downtime events that occurred during the timeframe

duration_hours: float

The duration of the downtime event in hours

end_time: datetime

The end time of the downtime event

formatdate-time

name: str

The display name of the downtime event

start_time: datetime

The start time of the downtime event

formatdate-time

downtime_hours: float

The total number of downtime hours during the timeframe

sla_urn: str

The unique identifier of the SLA

timeframe: SlaGetUptimeMetricsResponseItemTimeframe

The timeframe for which the uptime metrics are calculated

end: datetime

The ISO-formatted end datetime of the timeframe for which the metrics are calculated

formatdate-time

start: datetime

The ISO-formatted start datetime of the timeframe for which the metrics are calculated

formatdate-time

uptime_percentage: float

The percentage of uptime during the timeframe

vendor_urn: str

The unique identifier of the vendor

Get uptime metrics for an SLA data source

import os
from clarative import Clarative

client = Clarative(
    api_key=os.environ.get("CLARATIVE_API_KEY"),  # This is the default and can be omitted
)
response = client.slas.get_uptime_metrics(
    data_source_urn="data_source_urn",
    sla_urn="sla_urn",
)
print(response)

[
  {
    "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,
    "sla_urn": "sla_urn",
    "timeframe": {
      "end": "2019-12-27T18:11:19.117Z",
      "start": "2019-12-27T18:11:19.117Z"
    },
    "uptime_percentage": 0,
    "vendor_urn": "vendor_urn"
  }
]

Returns Examples

[
  {
    "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,
    "sla_urn": "sla_urn",
    "timeframe": {
      "end": "2019-12-27T18:11:19.117Z",
      "start": "2019-12-27T18:11:19.117Z"
    },
    "uptime_percentage": 0,
    "vendor_urn": "vendor_urn"
  }
]