@@ -338,6 +338,16 @@ components:
338338 required: true
339339 schema:
340340 type: string
341+ DisableCorrections:
342+ description: Whether to exclude correction windows from the SLO status calculation.
343+ Defaults to false.
344+ in: query
345+ name: disable_corrections
346+ required: false
347+ schema:
348+ default: false
349+ example: false
350+ type: boolean
341351 EntityID:
342352 description: UUID or Entity Ref.
343353 in: path
@@ -449,6 +459,15 @@ components:
449459 required: false
450460 schema:
451461 $ref: '#/components/schemas/RelationType'
462+ FromTimestamp:
463+ description: The starting timestamp for the SLO status query in epoch seconds.
464+ in: query
465+ name: from_ts
466+ required: true
467+ schema:
468+ example: 1690901870
469+ format: int64
470+ type: integer
452471 GCPSTSServiceAccountID:
453472 description: Your GCP STS enabled service account's unique ID.
454473 in: path
@@ -1088,6 +1107,14 @@ components:
10881107 required: false
10891108 schema:
10901109 type: boolean
1110+ SloID:
1111+ description: The ID of the SLO.
1112+ in: path
1113+ name: slo_id
1114+ required: true
1115+ schema:
1116+ example: 00000000-0000-0000-0000-000000000000
1117+ type: string
10911118 SpansMetricIDParameter:
10921119 description: The name of the span-based metric.
10931120 in: path
@@ -1109,6 +1136,15 @@ components:
11091136 required: true
11101137 schema:
11111138 type: string
1139+ ToTimestamp:
1140+ description: The ending timestamp for the SLO status query in epoch seconds.
1141+ in: query
1142+ name: to_ts
1143+ required: true
1144+ schema:
1145+ example: 1706803070
1146+ format: int64
1147+ type: integer
11121148 UserID:
11131149 description: The ID of the user.
11141150 in: path
@@ -43787,6 +43823,22 @@ components:
4378743823 from the other indexes
4378843824 type: string
4378943825 type: object
43826+ RawErrorBudgetRemaining:
43827+ description: The raw error budget remaining for the SLO.
43828+ properties:
43829+ unit:
43830+ description: The unit of the error budget (e.g., seconds, requests).
43831+ example: seconds
43832+ type: string
43833+ value:
43834+ description: The numeric value of the remaining error budget.
43835+ example: 86400.5
43836+ format: double
43837+ type: number
43838+ required:
43839+ - value
43840+ - unit
43841+ type: object
4379043842 ReadinessGate:
4379143843 description: Used to merge multiple branches into a single branch.
4379243844 properties:
@@ -53911,6 +53963,69 @@ components:
5391153963 required:
5391253964 - attributes
5391353965 type: object
53966+ SloStatusData:
53967+ description: The data portion of the SLO status response.
53968+ properties:
53969+ attributes:
53970+ $ref: '#/components/schemas/SloStatusDataAttributes'
53971+ id:
53972+ description: The ID of the SLO.
53973+ example: 00000000-0000-0000-0000-000000000000
53974+ type: string
53975+ type:
53976+ $ref: '#/components/schemas/SloStatusType'
53977+ required:
53978+ - id
53979+ - type
53980+ - attributes
53981+ type: object
53982+ SloStatusDataAttributes:
53983+ description: The attributes of the SLO status.
53984+ properties:
53985+ error_budget_remaining:
53986+ description: The percentage of error budget remaining.
53987+ example: 99.5
53988+ format: double
53989+ type: number
53990+ raw_error_budget_remaining:
53991+ $ref: '#/components/schemas/RawErrorBudgetRemaining'
53992+ sli:
53993+ description: The current Service Level Indicator (SLI) value as a percentage.
53994+ example: 99.95
53995+ format: double
53996+ type: number
53997+ span_precision:
53998+ description: The precision of the time span in seconds.
53999+ example: 2
54000+ format: int64
54001+ type: integer
54002+ state:
54003+ description: The current state of the SLO (e.g., breached, warning, ok).
54004+ example: ok
54005+ type: string
54006+ required:
54007+ - sli
54008+ - error_budget_remaining
54009+ - raw_error_budget_remaining
54010+ - state
54011+ - span_precision
54012+ type: object
54013+ SloStatusResponse:
54014+ description: The SLO status response.
54015+ properties:
54016+ data:
54017+ $ref: '#/components/schemas/SloStatusData'
54018+ required:
54019+ - data
54020+ type: object
54021+ SloStatusType:
54022+ description: The type of the SLO status resource.
54023+ enum:
54024+ - slo_status
54025+ example: slo_status
54026+ type: string
54027+ x-enum-varnames:
54028+ - SLO_STATUS
5391454029 SoftwareCatalogTriggerWrapper:
5391554030 description: Schema for a Software Catalog-based trigger.
5391654031 properties:
@@ -88060,6 +88175,63 @@ paths:
8806088175 x-unstable: '**Note**: This feature is in private beta. To request access, use
8806188176 the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
8806288177 docs.'
88178+ /api/v2/slo/{slo_id}/status:
88179+ get:
88180+ description: 'Get the status of a Service Level Objective (SLO) for a given
88181+ time period.
88182+
88183+
88184+ This endpoint returns the current SLI value, error budget remaining, and other
88185+ status information for the specified SLO.'
88186+ operationId: GetSloStatus
88187+ parameters:
88188+ - $ref: '#/components/parameters/SloID'
88189+ - $ref: '#/components/parameters/FromTimestamp'
88190+ - $ref: '#/components/parameters/ToTimestamp'
88191+ - $ref: '#/components/parameters/DisableCorrections'
88192+ responses:
88193+ '200':
88194+ content:
88195+ application/json:
88196+ schema:
88197+ $ref: '#/components/schemas/SloStatusResponse'
88198+ description: OK
88199+ '400':
88200+ content:
88201+ application/json:
88202+ schema:
88203+ $ref: '#/components/schemas/JSONAPIErrorResponse'
88204+ description: Bad Request
88205+ '403':
88206+ content:
88207+ application/json:
88208+ schema:
88209+ $ref: '#/components/schemas/JSONAPIErrorResponse'
88210+ description: Forbidden
88211+ '404':
88212+ content:
88213+ application/json:
88214+ schema:
88215+ $ref: '#/components/schemas/JSONAPIErrorResponse'
88216+ description: Not Found
88217+ '429':
88218+ $ref: '#/components/responses/TooManyRequestsResponse'
88219+ security:
88220+ - apiKeyAuth: []
88221+ appKeyAuth: []
88222+ - AuthZ:
88223+ - slos_read
88224+ summary: Get SLO status
88225+ tags:
88226+ - Service Level Objectives
88227+ x-permission:
88228+ operator: OR
88229+ permissions:
88230+ - slos_read
88231+ x-unstable: '**Note**: This endpoint is in public beta and it''s subject to
88232+ change.
88233+
88234+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8806388235 /api/v2/spa/recommendations/{service}:
8806488236 get:
8806588237 description: This endpoint is currently experimental and restricted to Datadog
0 commit comments