SLOs dashboard

This contains APIs related to SLOs dashboard

Get all SLOs count by risk

SecurityApiKey
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

userJourneyIdentifiers
Array of strings

For filtering on the basis of user journeys' identifiers

monitoredServiceIdentifier
string

For filtering on the basis of monitored services' identifiers

sliTypes
Array of strings

For filtering on the basis of SLI types

Items Enum: "Availability" "Latency"
targetTypes
Array of strings

For filtering on the basis of target types

Items Enum: "Rolling" "Calender"
errorBudgetRisks
Array of strings

For filtering on the basis of error budget risks

Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"
filter
string

For filtering on the basis of name

Responses
400

Bad Request

500

Internal Server Error

default

Get the risk count for all SLOs

get/cv/api/slo-dashboard/risk-count
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get SLO consumption breakdown

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
startTime
integer <int64>
endTime
integer <int64>
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLO's details

get/cv/api/slo-dashboard/widget/{identifier}/consumption
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get SLO dashboard details

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
startTime
integer <int64>
endTime
integer <int64>
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLO's details

get/cv/api/slo-dashboard/widget/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get SLO list view

SecurityApiKey
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

userJourneyIdentifiers
Array of strings

For filtering on the basis of user journeys' identifiers

monitoredServiceIdentifier
string

For filtering on the basis of monitored services' identifiers

sliTypes
Array of strings

For filtering on the basis of SLI types

Items Enum: "Availability" "Latency"
targetTypes
Array of strings

For filtering on the basis of target types

Items Enum: "Rolling" "Calender"
errorBudgetRisks
Array of strings

For filtering on the basis of error budget risks

Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"
filter
string

For filtering on the basis of name

pageNumber
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32>
Default: 10

Results per page

Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLOs for list view

get/cv/api/slo-dashboard/widgets/list
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get SLO list view

SecurityApiKey
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

pageNumber
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32>
Default: 10

Results per page

Request Body schema: */*
userJourneyIdentifiers
Array of strings
monitoredServiceIdentifier
string
sliTypes
Array of strings
Items Enum: "Availability" "Latency"
targetTypes
Array of strings
Items Enum: "Rolling" "Calender"
errorBudgetRisks
Array of strings
Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"
searchFilter
string
type
string
Enum: "Simple" "Composite"
object (SLOTargetFilterDTO)
compositeSLOIdentifier
string
Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLOs for list view

post/cv/api/slo-dashboard/widgets/list
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get widget listDeprecated

SecurityApiKey
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

userJourneyIdentifiers
Array of strings

For filtering on the basis of user journeys' identifiers

monitoredServiceIdentifier
string

For filtering on the basis of monitored services' identifiers

sliTypes
Array of strings

For filtering on the basis of SLI types

Items Enum: "Availability" "Latency"
targetTypes
Array of strings

For filtering on the basis of target types

Items Enum: "Rolling" "Calender"
errorBudgetRisks
Array of strings

For filtering on the basis of error budget risks

Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"
filter
string

For filtering on the basis of name

pageNumber
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32>
Default: 10

Results per page

Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLOs for dashboard

get/cv/api/slo-dashboard/widgets
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getSLOAssociatedMonitoredServices

SecurityApiKey
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

pageNumber
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32>
Default: 10

Results per page

Responses
400

Bad Request

500

Internal Server Error

get/cv/api/slo-dashboard/monitored-services
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}