Instana Service Levels Objective(SLO) Report API
The Service Levels Objective(SLO) Report API from Instana — 1 operation(s) for service levels objective(slo) report.
OpenAPI Specification
openapi: 3.0.1
info:
contact:
email: support@instana.com
name: © Instana
url: http://instana.com
termsOfService: https://www.instana.com/terms-of-use/
title: Instana REST API documentation Service Levels Objective(SLO) Report API
version: 1.307.1417
x-ibm-ahub-try: true
x-logo:
altText: instana logo
backgroundColor: '#FAFBFC'
url: header-logo.svg
description: "Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f).\n\n<div style=\"background-color:#e6f0ff; padding: 12px; border-left: 6px solid #0052cc; font-size: 14px; display: flex; align-items: center;\">\n <img src=\"https://img.icons8.com/ios-filled/50/0052cc/info.png\" width=\"18\" height=\"18\" style=\"margin-right: 8px;\" alt=\"info icon\"/>\n <span>\n <b>Our API documentation is moving to</b> \n <a href=\"https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Introduction\" target=\"_blank\">API Hub</a>\n\t — please update your bookmarks now, as the current site will be deprecated after Release-306.\n </span>\n</div>\n\n## Overview\nThe Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management.\n\n### Navigating the API documentation\nThe API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include:\n- Websites & Mobile Apps\n- Applications\n- Infrastructure\n- Synthetic Monitoring\n- Events\n- Automation\n- Service Levels\n- Settings\n- etc\n\n### Rate Limiting\nA rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server.\n\n- **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour.\n- **X-RateLimit-Remaining:** How many calls may still be executed within the current hour.\n- **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00.\n\n### Further Reading\nWe provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana.\n\n## Getting Started with the REST API\n\n### API base URL\nThe base URL for an specific instance of Instana can be determined using the tenant and unit information.\n- `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface.\n- `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself.\n\n### Curl Example\nHere is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call.\n\n```bash\ncurl --request GET \\\n --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx'\n```\n\nNext we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example.\n\n```bash\ncurl --request POST \\\n --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\\n --header 'content-type: application/json' \\\n --data '{\n \"group\":{\n \"groupbyTag\":\"endpoint.name\"\n },\n \"tagFilters\":[\n \t{\n \t\t\"name\":\"call.error.count\",\n \t\t\"value\":\"0\",\n \t\t\"operator\":\"GREATER_THAN\"\n \t}\n ],\n \"metrics\":[\n \t{\n \t\t\"metric\":\"errors\",\n \t\t\"aggregation\":\"MEAN\"\n \t}\n ]\n }'\n```\n\n### Generating REST API clients\n\nThe API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format.\nYou can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml).\n\nOpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made.\nTo generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator).\n\n#### Go\nFor example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit:\n\n```bash\n#!/bin/bash\n\n### This script assumes you have the `java` and `wget` commands on the path\n\nexport UNIT_NAME='myunit' # for example: prod\nexport TENANT_NAME='mytenant' # for example: awesomecompany\n\n//Download the generator to your current working directory:\nwget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\"\n\n//generate a client library that you can vendor into your repository\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\\n -o pkg/instana/openapi \\\n --skip-validate-spec\n\n//(optional) format the Go code according to the Go code standard\ngofmt -s -w pkg/instana/openapi\n```\n\nThe generated clients contain comprehensive READMEs, and you can start right away using the client from the example above:\n\n```go\nimport instana \"./pkg/instana/openapi\"\n\n// readTags will read all available application monitoring tags along with their type and category\nfunc readTags() {\n\tconfiguration := instana.NewConfiguration()\n\tconfiguration.Host = \"tenant-unit.instana.io\"\n\tconfiguration.BasePath = \"https://tenant-unit.instana.io\"\n\n\tclient := instana.NewAPIClient(configuration)\n\tauth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{\n\t\tKey: apiKey,\n\t\tPrefix: \"apiToken\",\n\t})\n\n\ttags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth)\n\tif err != nil {\n\t\tfmt.Fatalf(\"Error calling the API, aborting.\")\n\t}\n\n\tfor _, tag := range tags {\n\t\tfmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name)\n\t}\n}\n```\n\n#### Java\nFollow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar).\n\nDepending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification:\n```\n//Nativ Java HTTP Client\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native\n\n//Spring WebClient\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient\n\n//Spring RestTemplate\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate\n\n```\n"
servers:
- description: Instana Backend
url: https://{unit}-{tenant}.instana.io
variables:
tenant:
default: tenant
description: Customer tenant unit
unit:
default: unit
description: Customer tenant name
- description: Instana Self-Hosted Backend
url: https://{domain}
variables:
domain:
default: example.com
description: Customer Self-Hosted domain
tags:
- name: Service Levels Objective(SLO) Report
paths:
/api/slo/report/{sloId}:
get:
operationId: getSlo
parameters:
- description: Service Levels Objective(SLO) Configuration ID
example: SLOEANnWh9tQOa2h88kGxK6wQ
in: path
name: sloId
required: true
schema:
type: string
- description: Starting point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds
example: 1706713140000
in: query
name: from
schema:
type: string
- description: Ending point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds
example: 1706813100000
in: query
name: to
schema:
type: string
- description: IDs of Correction Configurations to be Excluded from the result
example: N1Xj6q8QTZu_cfJOGqy4mg
in: query
name: excludeCorrectionId
schema:
type: array
items:
type: string
uniqueItems: true
- description: IDs of Correction Configurations to be Included in the result
example: uvP7Z03pSUuybDT8-WHLDA
in: query
name: includeCorrectionId
schema:
type: array
items:
type: string
uniqueItems: true
responses:
'200':
content:
application/json:
example:
sli: 1
slo: 0.9999
totalErrorBudget: 12
errorBudgetRemaining: 12
errorBudgetSpent: 0
fromTimestamp: 1705081552605
toTimestamp: 1705686352605
violationDistribution:
'0': 0
'1': 0
'2': 0
'3': 0
'4': 0
'5': 0
'6': 0
'7': 0
'8': 0
'9': 0
'10': 0
'11': 0
'12': 0
'13': 0
'14': 0
'15': 0
'16': 0
'17': 0
'18': 0
'19': 0
'20': 0
'21': 0
'22': 0
'23': 0
'24': 0
'25': 0
'26': 0
'27': 0
'28': 0
'29': 0
'30': 0
'31': 0
'32': 0
'33': 0
'34': 0
'35': 0
'36': 0
'37': 0
'38': 0
'39': 0
'40': 0
'41': 0
'42': 0
'43': 0
'44': 0
'45': 0
'46': 0
'47': 0
'48': 0
'49': 0
'50': 0
'51': 0
'52': 0
'53': 0
'54': 0
'55': 0
'56': 0
'57': 0
'58': 0
'59': 0
'60': 0
'61': 0
'62': 0
'63': 0
'64': 0
'65': 0
'66': 0
'67': 0
'68': 0
'69': 0
'70': 0
'71': 0
'72': 0
'73': 0
'74': 0
'75': 0
'76': 0
'77': 0
'78': 0
'79': 0
'80': 0
'81': 0
'82': 0
'83': 0
'84': 0
'85': 0
'86': 0
'87': 0
'88': 0
'89': 0
'90': 0
'91': 0
'92': 0
'93': 0
'94': 0
'95': 0
'96': 0
'97': 0
'98': 0
'99': 0
'100': 0
'101': 0
'102': 0
'103': 0
'104': 0
'105': 0
'106': 0
'107': 0
'108': 0
'109': 0
'110': 0
'111': 0
'112': 0
'113': 0
'114': 0
'115': 0
'116': 0
'117': 0
'118': 0
'119': 0
'120': 0
'121': 0
'122': 0
'123': 0
'124': 0
'125': 0
'126': 0
'127': 0
'128': 0
'129': 0
'130': 0
'131': 0
'132': 0
'133': 0
'134': 0
'135': 0
'136': 0
'137': 0
'138': 0
'139': 0
'140': 0
'141': 0
'142': 0
'143': 0
'144': 0
'145': 0
'146': 0
'147': 0
'148': 0
'149': 0
'150': 0
'151': 0
'152': 0
'153': 0
'154': 0
'155': 0
'156': 0
'157': 0
'158': 0
'159': 0
'160': 0
'161': 0
'162': 0
'163': 0
'164': 0
'165': 0
'166': 0
'167': 0
errorChart:
'0': 0
'1': 0
'2': 0
'3': 0
'4': 0
'5': 0
'6': 0
'7': 0
'8': 0
'9': 0
'10': 0
'11': 0
'12': 0
'13': 0
'14': 0
'15': 0
'16': 0
'17': 0
'18': 0
'19': 0
'20': 0
'21': 0
'22': 0
'23': 0
'24': 0
'25': 0
'26': 0
'27': 0
'28': 0
'29': 0
'30': 0
'31': 0
'32': 0
'33': 0
'34': 0
'35': 0
'36': 0
'37': 0
'38': 0
'39': 0
'40': 0
'41': 0
'42': 0
'43': 0
'44': 0
'45': 0
'46': 0
'47': 0
'48': 0
'49': 0
'50': 0
'51': 0
'52': 0
'53': 0
'54': 0
'55': 0
'56': 0
'57': 0
'58': 0
'59': 0
'60': 0
'61': 0
'62': 0
'63': 0
'64': 0
'65': 0
'66': 0
'67': 0
'68': 0
'69': 0
'70': 0
'71': 0
'72': 0
'73': 0
'74': 0
'75': 0
'76': 0
'77': 0
'78': 0
'79': 0
'80': 0
'81': 0
'82': 0
'83': 0
'84': 0
'85': 0
'86': 0
'87': 0
'88': 0
'89': 0
'90': 0
'91': 0
'92': 0
'93': 0
'94': 0
'95': 0
'96': 0
'97': 0
'98': 0
'99': 0
'100': 0
'101': 0
'102': 0
'103': 0
'104': 0
'105': 0
'106': 0
'107': 0
'108': 0
'109': 0
'110': 0
'111': 0
'112': 0
'113': 0
'114': 0
'115': 0
'116': 0
'117': 0
'118': 0
'119': 0
'120': 0
'121': 0
'122': 0
'123': 0
'124': 0
'125': 0
'126': 0
'127': 0
'128': 0
'129': 0
'130': 0
'131': 0
'132': 0
'133': 0
'134': 0
'135': 0
'136': 0
'137': 0
'138': 0
'139': 0
'140': 0
'141': 0
'142': 0
'143': 0
'144': 0
'145': 0
'146': 0
'147': 0
'148': 0
'149': 0
'150': 0
'151': 0
'152': 0
'153': 0
'154': 0
'155': 0
'156': 0
'157': 0
'158': 0
'159': 0
'160': 0
'161': 0
'162': 0
'163': 0
'164': 0
'165': 0
'166': 0
'167': 0
errorAccumulationChart:
'0': 0
'1': 0
'2': 0
'3': 0
'4': 0
'5': 0
'6': 0
'7': 0
'8': 0
'9': 0
'10': 0
'11': 0
'12': 0
'13': 0
'14': 0
'15': 0
'16': 0
'17': 0
'18': 0
'19': 0
'20': 0
'21': 0
'22': 0
'23': 0
'24': 0
'25': 0
'26': 0
'27': 0
'28': 0
'29': 0
'30': 0
'31': 0
'32': 0
'33': 0
'34': 0
'35': 0
'36': 0
'37': 0
'38': 0
'39': 0
'40': 0
'41': 0
'42': 0
'43': 0
'44': 0
'45': 0
'46': 0
'47': 0
'48': 0
'49': 0
'50': 0
'51': 0
'52': 0
'53': 0
'54': 0
'55': 0
'56': 0
'57': 0
'58': 0
'59': 0
'60': 0
'61': 0
'62': 0
'63': 0
'64': 0
'65': 0
'66': 0
'67': 0
'68': 0
'69': 0
'70': 0
'71': 0
'72': 0
'73': 0
'74': 0
'75': 0
'76': 0
'77': 0
'78': 0
'79': 0
'80': 0
'81': 0
'82': 0
'83': 0
'84': 0
'85': 0
'86': 0
'87': 0
'88': 0
'89': 0
'90': 0
'91': 0
'92': 0
'93': 0
'94': 0
'95': 0
'96': 0
'97': 0
'98': 0
'99': 0
'100': 0
'101': 0
'102': 0
'103': 0
'104': 0
'105': 0
'106': 0
'107': 0
'108': 0
'109': 0
'110': 0
'111': 0
'112': 0
'113': 0
'114': 0
'115': 0
'116': 0
'117': 0
'118': 0
'119': 0
'120': 0
'121': 0
'122': 0
'123': 0
'124': 0
'125': 0
'126': 0
'127': 0
'128': 0
'129': 0
'130': 0
'131': 0
'132': 0
'133': 0
'134': 0
'135': 0
'136': 0
'137': 0
'138': 0
'139': 0
'140': 0
'141': 0
'142': 0
'143': 0
'144': 0
'145': 0
'146': 0
'147': 0
'148': 0
'149': 0
'150': 0
'151': 0
'152': 0
'153': 0
'154': 0
'155': 0
'156': 0
'157': 0
'158': 0
'159': 0
'160': 0
'161': 0
'162': 0
'163': 0
'164': 0
'165': 0
'166': 0
'167': 0
errorBudgetRemainChart:
'0': 0
'1': 0
'2': 0
'3': 0
'4': 0
'5': 0
'6': 0
'7': 0
'8': 0
'9': 0
'10': 1
'11': 1
'12': 1
'13': 1
'14': 1
'15': 1
'16': 1
'17': 1
'18': 1
'19': 1
'20': 1
'21': 2
'22': 2
'23': 2
'24': 2
'25': 2
'26': 2
'27': 2
'28': 2
'29': 2
'30': 2
'31': 2
'32': 2
'33': 3
'34': 3
'35': 3
'36': 3
'37': 3
'38': 3
'39': 3
'40': 3
'41': 3
'42': 3
'43': 3
'44': 4
'45': 4
'46': 4
'47': 4
'48': 4
'49': 4
'50': 4
'51': 4
'52': 4
'53': 4
'54': 4
'55': 4
'56': 5
'57': 5
'58': 5
'59': 5
'60': 5
'61': 5
'62': 5
'63': 5
'64': 5
'65': 5
'66': 5
'67': 6
'68': 6
'69': 6
'70': 6
'71': 6
'72': 6
'73': 6
'74': 6
'75': 6
'76': 6
'77': 6
'78': 6
'79': 7
'80': 7
'81': 7
'82': 7
'83': 7
'84': 7
'85': 7
'86': 7
'87': 7
'88': 7
'89': 7
'90': 7
'91': 7
'92': 7
'93': 7
'94': 7
'95': 7
'96': 7
'97': 7
'98': 7
'99': 7
'100': 7
'101': 7
'102': 7
'103': 7
'104': 7
'105': 7
'106': 7
'107': 7
'108': 7
'109': 7
'110': 7
'111': 7
'112': 7
'113': 7
'114': 7
'115': 8
'116': 8
'117': 8
'118': 8
'119': 8
'120': 8
'121': 8
'122': 8
'123': 8
'124': 8
'125': 8
'126': 8
'127': 9
'128': 9
'129': 9
'130': 9
'131': 9
'132': 9
'133': 9
'134': 9
'135': 9
'136': 9
'137': 9
'138': 10
'139': 10
'140': 10
'141': 10
'142': 10
'143': 10
'144': 10
'145': 10
'146': 10
'147': 10
'148': 10
'149': 10
'150': 11
'151': 11
'152': 11
'153': 11
'154': 11
'155': 11
'156': 11
'157': 11
'158': 11
'159': 11
'160': 11
'161': 12
'162': 12
'163': 12
'164': 12
'165': 12
'166': 12
'167': 12
schema:
type: array
items:
$ref: '#/components/schemas/SloReport'
description: Fetched SLO Configuration Report Successfully
'404':
content:
application/json:
example:
errors:
- There is no SLO configuration for the given ID or the report hasn't been generated yet.
schema:
type: array
items:
type: string
description: There is no SLO configuration for the given ID or the report hasn't been generated yet.
security:
- ApiKeyAuth:
- Default
summary: Generate Service Levels report
tags:
- Service Levels Objective(SLO) Report
x-ibm-ahub-byok: true
components:
schemas:
SloReport:
type: object
properties:
errorAccumulationChart:
type: object
additionalProperties:
type: integer
format: int32
description: Value of accumulated bad minutes/events of SLO configuration in different timestamps from starting to ending point
description: Value of accumulated bad minutes/events of SLO configuration in different timestamps from starting to ending point
errorBudgetRemainChart:
type: object
additionalProperties:
type: integer
format: int32
description: Error Budget Remain value of SLO configuration in different timestamps from starting to ending point
description: Error Budget Remain value of SLO configuration in different timestamps from starting to ending point
errorBudgetRemaining:
type: integer
format: int32
description: Latest Remaining Error Budget value of SLO Configuration
errorBudgetSpent:
type: integer
format: int32
description: Spent Error Budget of SLO Configuration
errorBurnRate:
type: integer
format: int32
description: Latest Burn Rate value of SLO Configuration
errorBurnRateChart:
type: object
additionalProperties:
type: integer
format: int32
description: Budget Rate value of SLO configuration in different timestamps from starting to ending point
description: Budget Rate value of SLO configuration in different timestamps from starting to ending point
errorChart:
type: object
additionalProperties:
type: integer
format: int32
description: Value indicating presence of bad minutes/events of SLO configuration in different timestamps from starting to ending point
description: Value indicating presence of bad minutes/events of SLO configuration in different timestamps from starting to ending point
fromTimestamp:
type: integer
format: int64
description: Starting point of the data retrieval, specified as 13 digit Unix Timestamp milliseconds
sli:
type: number
format: double
description: Latest Status value of SLO Configuration
slo:
type: number
format: double
description: Target status of SLO Configuration
toTimestamp:
type: integer
format: int64
description: Ending point of the data retrieval, specified as 13 digit Unix Timestamp milliseconds
totalErrorBudget:
type: integer
format: int32
description: Latest Available Error Budget value of SLO Configuration
violationDistribution:
type: object
additionalProperties:
type: integer
format: int32
description: Value indicating violation of SLO configuration in different timestamps from starting to ending point
description: Value indicating violation of SLO configuration in different timestamps from starting to ending point
securitySchemes:
ApiKeyAuth:
in: header
name: authorization
type: apiKey
description: "## Example\n\n```bash\ncurl --request GET \\\n --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx'\n```\n"
x-tagGroups:
- name: Websites & Mobile Apps
tags:
- Website Met
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-service-levels-objective-slo-report-api-openapi.yml