Instana Business Monitoring API
The Business Monitoring API from Instana — 5 operation(s) for business monitoring.
The Business Monitoring API from Instana — 5 operation(s) for business monitoring.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/instana-business-monitoring-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
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 Business Monitoring 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?
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: Business Monitoring
paths:
/api/business-monitoring/activities:
post:
operationId: getActivities
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetActivities'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CursorPaginatedBusinessActivityItem'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get Business Activities
tags:
- Business Monitoring
x-ibm-ahub-byok: true
/api/business-monitoring/activities/csv:
post:
operationId: getActivitiesCsv
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetActivities'
responses:
'200':
content:
text/csv:
schema:
$ref: '#/components/schemas/BusinessActivity'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Download Business Activities
tags:
- Business Monitoring
x-ibm-ahub-byok: true
/api/business-monitoring/business-perspectives:
get:
operationId: getBusinessPerspectives
responses:
'200':
content:
application/json:
example:
- id: gBwNFIbjS6Ozwt0a12regg
label: biz-perspective
name: biz-perspective
description: This is an example business perspective
rbacTags:
- id: 0xHKaxfaS161Al6Qc23g4w
displayName: team 1
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: OR
elements:
- type: TAG_FILTER
name: service.name
stringValue: my-service-1
numberValue: null
booleanValue: null
key: null
value: my-service-1
operator: EQUALS
entity: DESTINATION
- type: TAG_FILTER
name: service.name
stringValue: my-service-2
numberValue: null
booleanValue: null
key: null
value: my-service-2
operator: EQUALS
entity: DESTINATION
schema:
$ref: '#/components/schemas/BusinessPerspectiveConfig'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get all business perspectives
tags:
- Business Monitoring
x-ibm-ahub-byok: true
post:
operationId: createBusinessPerspective
requestBody:
content:
application/json:
example:
label: biz-perspective
name: biz-perspective
description: This is an example business perspective
rbacTags:
- id: 0xHKaxfaS161Al6Qc23g4w
displayName: team 1
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: OR
elements:
- type: TAG_FILTER
name: service.name
stringValue: my-service-1
numberValue: null
booleanValue: null
key: null
value: my-service-1
operator: EQUALS
entity: DESTINATION
- type: TAG_FILTER
name: service.name
stringValue: my-service-2
numberValue: null
booleanValue: null
key: null
value: my-service-2
operator: EQUALS
entity: DESTINATION
schema:
$ref: '#/components/schemas/NewBusinessPerspectiveConfig'
required: true
responses:
'200':
content:
application/json:
example:
id: gBwNFIbjS6Ozwt0a12regg
label: biz-perspective
name: biz-perspective
description: This is an example business perspective
rbacTags:
- id: 0xHKaxfaS161Al6Qc23g4w
displayName: team 1
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: OR
elements:
- type: TAG_FILTER
name: service.name
stringValue: my-service-1
numberValue: null
booleanValue: null
key: null
value: my-service-1
operator: EQUALS
entity: DESTINATION
- type: TAG_FILTER
name: service.name
stringValue: my-service-2
numberValue: null
booleanValue: null
key: null
value: my-service-2
operator: EQUALS
entity: DESTINATION
schema:
$ref: '#/components/schemas/BusinessPerspectiveConfig'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Create business perspective
tags:
- Business Monitoring
x-ibm-ahub-byok: true
/api/business-monitoring/business-perspectives/{id}:
delete:
operationId: deleteBusinessPerspective
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
default:
content:
application/json: {}
description: default response
security:
- ApiKeyAuth:
- Default
summary: Delete business perspective
tags:
- Business Monitoring
x-ibm-ahub-byok: true
get:
operationId: getBusinessPerspective
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
id: gBwNFIbjS6Ozwt0a12regg
label: biz-perspective
name: biz-perspective
description: This is an example business perspective
rbacTags:
- id: 0xHKaxfaS161Al6Qc23g4w
displayName: team 1
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: OR
elements:
- type: TAG_FILTER
name: service.name
stringValue: my-service-1
numberValue: null
booleanValue: null
key: null
value: my-service-1
operator: EQUALS
entity: DESTINATION
- type: TAG_FILTER
name: service.name
stringValue: my-service-2
numberValue: null
booleanValue: null
key: null
value: my-service-2
operator: EQUALS
entity: DESTINATION
schema:
$ref: '#/components/schemas/BusinessPerspectiveConfig'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get business perspective
tags:
- Business Monitoring
x-ibm-ahub-byok: true
put:
operationId: updateBusinessPerspective
parameters:
- in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
label: biz-perspective
name: biz-perspective
rbacTags:
- id: 0xHKaxfaS161Al6Qc23g4w
displayName: team 1
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: OR
elements:
- type: TAG_FILTER
name: service.name
stringValue: my-service-1
numberValue: null
booleanValue: null
key: null
value: my-service-1
operator: EQUALS
entity: DESTINATION
- type: TAG_FILTER
name: service.name
stringValue: my-service-2
numberValue: null
booleanValue: null
key: null
value: my-service-2
operator: EQUALS
entity: DESTINATION
schema:
$ref: '#/components/schemas/UpdatedBusinessPerspectiveConfig'
required: true
responses:
'200':
content:
application/json:
example:
id: gBwNFIbjS6Ozwt0a12regg
label: biz-perspective
name: biz-perspective
description: This is an example business perspective
rbacTags:
- id: 0xHKaxfaS161Al6Qc23g4w
displayName: team 1
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: AND
elements:
- type: EXPRESSION
logicalOperator: OR
elements:
- type: TAG_FILTER
name: service.name
stringValue: my-service-1
numberValue: null
booleanValue: null
key: null
value: my-service-1
operator: EQUALS
entity: DESTINATION
- type: TAG_FILTER
name: service.name
stringValue: my-service-2
numberValue: null
booleanValue: null
key: null
value: my-service-2
operator: EQUALS
entity: DESTINATION
schema:
$ref: '#/components/schemas/BusinessPerspectiveConfig'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Update business perspective
tags:
- Business Monitoring
x-ibm-ahub-byok: true
/api/business-monitoring/catalog:
get:
operationId: getBusinessTagCatalog
parameters:
- in: query
name: from
schema:
type: integer
format: int64
- in: query
name: useCase
schema:
type: string
enum:
- GROUPING
- FILTERING
- SERVICE_MAPPING
- SMART_ALERTS
- SMART_ALERTS_LOGS
- SMART_ALERTS_ADAPTIVE_BASELINE
- SMART_ALERTS_CUSTOM_PAYLOAD
- SLI_MANAGEMENT
- APPLICATION_CONFIG
- APPLICATION_CONFIG_BLUEPRINT
- MAINTENANCE_WINDOWS
- BIZOPS_CUSTOM_DASHBOARDS_FILTERING
responses:
'200':
content:
application/json:
example:
tagTree:
- label: Region or Environment
description: null
icon: null
children:
- label: Zone
description: null
icon: null
children:
- label: Agent Zone
tagName: agent.zone
type: TAG
- label: Ec2 Zone
tagName: aws.ec2.zone
type: TAG
- label: Azure Zone
tagName: azure.zone
type: TAG
type: LEVEL
queryable: false
- label: Cloud
description: null
icon: null
children:
- label: Aws Arn
tagName: aws.arn
type: TAG
- label: Ec2 Ipv4
tagName: aws.ec2.ipv4
type: TAG
- label: Ec2 PublicName
tagName: aws.ec2.publicName
type: TAG
- label: Ec2 Tag
tagName: aws.ec2.tag
type: TAG
- label: Ec2 Zone
tagName: aws.ec2.zone
type: TAG
- label: Ecs Cluster Name
tagName: aws.ecs.cluster.name
type: TAG
- label: Azure Zone
tagName: azure.zone
type: TAG
- label: Gce Tag
tagName: gce.tag
type: TAG
- label: Gce Zone
tagName: gce.zone
type: TAG
- label: Cloud Provider
tagName: cloud.provider
type: TAG
type: LEVEL
queryable: false
- label: Host
description: null
icon: null
children:
- label: Http Host
tagName: call.http.host
type: TAG
- label: Host Fqdn
tagName: host.fqdn
type: TAG
- label: Host Ip
tagName: host.ip
type: TAG
- label: Host Name
tagName: host.name
type: TAG
- label: Host Zone
tagName: host.zone
type: TAG
- label: Jboss Node Name
tagName: jboss.node.name
type: TAG
- label: Kubernetes Cluster Name
tagName: kubernetes.cluster.name
type: TAG
- label: Kubernetes Node Name
tagName: kubernetes.node.name
type: TAG
type: LEVEL
queryable: false
type: LEVEL
queryable: false
- label: custom
description: null
icon: null
children:
- label: HTTP
description: null
icon: null
children:
- label: Http Header
tagName: call.http.header
type: TAG
- label: Http Params
tagName: call.http.params
type: TAG
- label: Http PathTemplate
tagName: call.http.pathTemplate
type: TAG
type: LEVEL
queryable: false
- label: Miscellaneous
description: null
icon: null
children:
- label: Agent Tag
tagName: agent.tag
type: TAG
- label: Ec2 Tag
tagName: aws.ec2.tag
type: TAG
- label: Call Tag
tagName: call.tag
type: TAG
type: LEVEL
queryable: false
- label: Platform
description: null
icon: null
children:
- label: Docker Label
tagName: docker.label
type: TAG
- label: Kubernetes Label
tagName: kubernetes.label
type: TAG
- label: Kubernetes Deployment Label
tagName: kubernetes.deployment.label
type: TAG
- label: Kubernetes Pod Label
tagName: kubernetes.pod.label
type: TAG
- label: Openshift Deploymentconfig Label
tagName: openshift.deploymentconfig.label
type: TAG
type: LEVEL
queryable: false
type: LEVEL
queryable: false
tags: []
schema:
$ref: '#/components/schemas/TagCatalog'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get business tag catalog
tags:
- Business Monitoring
x-ibm-ahub-byok: true
components:
schemas:
TagFilterExpressionElement:
type: object
description: Boolean expression of tag filters to define the scope of relevant calls.
discriminator:
mapping:
EXPRESSION: '#/components/schemas/TagFilterExpression'
TAG_FILTER: '#/components/schemas/TagFilter'
propertyName: type
properties:
type:
type: string
required:
- type
Tag:
type: object
description: 'List of queryable tags available in a tagTree. Eg: `call.erroneous`.
Consider these tags as attributes of a tagTree. Eg: `Call` tagTree has have `Erroneous`, `Call name`, `Latency` etc as attributes.
'
properties:
aliases:
type: array
description: 'List of other names that can refer to this tag
'
items:
type: string
description: 'List of other names that can refer to this tag
'
uniqueItems: true
availability:
type: array
description: 'List of product areas this tag is available in
'
items:
type: string
description: 'List of product areas this tag is available in
'
enum:
- INFRASTRUCTURE_METRICS
- APPLICATION
- WEBSITE
- MOBILE_APP
- EUM
- EUM_IMPACTED_BEACON
- EVENT
- SLI
- SLO
- SLO_PREVIEW
- USAGE
- LOG
- SYNTHETICS
- SYNTHETICS_DETAIL
- APDEX
- BIZOPS
- BUSINESS_METRICS
- SUBTRACE
- UNKNOWN
uniqueItems: true
canApplyToDestination:
type: boolean
description: 'Whether the tag is available for destination or not.
If source and destination is false, it means the tag is independent of source and destination. Eg: of such tag is `call.http.path`.
'
canApplyToSource:
type: boolean
description: 'Whether the tag is available for source or not.
If source and destination is false, it means the tag is independent of source and destination. Eg: of such tag is `call.http.path`.
'
description:
type: string
description: The description of the tag if it is provided.
idTag:
type: boolean
description: 'Whether the Tag is a unique ID or not.
Eg: `idTag` for `endpoint.id` is true but for `call.rpc.method` it is false.
'
label:
type: string
description: 'The name of the tag which is seen in the UI. Eg: `Call name`'
maxLength: 256
minLength: 0
name:
type: string
description: 'The name of the tag. Eg: `call.name`'
type:
type: string
description: 'The data type of the tag. Eg: `call.name` accepts `STRING` value.'
enum:
- BOOLEAN
- STRING
- NUMBER
- STRING_SET
- STRING_LIST
- KEY_VALUE_PAIR
- FLOAT_LIST
- KEY_NUMBER_PAIR
required:
- name
- type
TimeFrame:
type: object
description: Time range for which the data should be retrieved.
properties:
to:
type: integer
format: int64
description: 'end of timeframe expressed as the Unix epoch time in milliseconds. Eg: `ISO 8601` standard time `2024-06-27T05:05:55.615Z` can be represented as `1719464755615` in Unix epoch time in milliseconds.'
windowSize:
type: integer
format: int64
description: windowSize in milliseconds
maximum: 2678400000
minimum: 0
Order:
type: object
description: 'Specifies the ordering of the results.
It contains fields that define the sorting criteria, the collation for sorting, and the direction in which the results should be ordered.
'
properties:
by:
type: string
description: If the granularity is set to `1` you can use the metric name eg. `latency.p95` to order by that value.
collation:
type: string
description: Language code used for sorting. Ignored for infrastructure queries.
direction:
type: string
description: The order in which results will be sorted, either `ASC` for ascending or `DESC` for descending.
enum:
- ASC
- DESC
required:
- by
- direction
NewBusinessPerspectiveConfig:
type: object
properties:
description:
type: string
maxLength: 300
minLength: 0
name:
type: string
maxLength: 100
minLength: 0
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
UpdatedBusinessPerspectiveConfig:
type: object
properties:
description:
type: string
maxLength: 300
minLength: 0
name:
type: string
maxLength: 100
minLength: 0
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
BusinessPerspectiveConfig:
type: object
properties:
description:
type: string
maxLength: 300
minLength: 0
id:
type: string
maxLength: 128
minLength: 1
name:
type: string
maxLength: 100
minLength: 0
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
required:
- id
IngestionOffsetCursor:
type: object
description: Cursor to use between successive queries
CursorPaginatedBusinessActivityItem:
type: object
properties:
businessActivity:
$ref: '#/components/schemas/BusinessActivity'
cursor:
$ref: '#/components/schemas/IngestionOffsetCursor'
metrics:
type: object
additionalProperties:
type: array
items:
type: array
items:
type: number
required:
- cursor
BusinessActivity:
type: object
properties:
activityId:
type:
- string
- 'null'
description: Unique identifier for the activity generated by the source BPM tool
example: ApproveInvoiceTask
activityName:
type:
- string
- 'null'
description: 'Name of the activity '
example: Approve Invoice
activityStart:
type:
- integer
- 'null'
format: int64
description: Unix timestamp representing the activity's start time
example: 1680559706000
activityType:
type: string
description: 'Type of the activity '
example: userTask
callId:
type: string
writeOnly: true
endpointIds:
type: array
items:
type: string
processDefinitionId:
type:
- string
- 'null'
description: The identifier of the process the activity is an instance of.
example: invoice:2:aa2bbbcc-bb04-11ee-9d4e-0242ac110002
processDefinitionName:
type:
- string
- 'null'
description: The name of the process that the activity is an instance of
example: Invoice Approval
rootProcessInstanceId:
type:
- string
- 'null'
description: The id of the root process for the activity
example: 486cbb3b-e633-11ee-8707-0242ac110002
required:
- activityType
TagTreeLevel:
type: object
description: 'The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: `Call`.
Consider this as the root of the tree where it has tags as attributes or children.
'
properties:
children:
type: array
description: Children tags of tagTree
items:
$ref: '#/components/schemas/TagTreeNode'
description:
type: string
description: The description provided, if any.
maxLength: 512
minLength: 0
icon:
type: string
description: 'Each tag has an Icon which can be seen on the drop down list in Unbounded Analytics.
If there is an icon, there will be a string associated with it.
Eg: For for all `TAG` under `Call` tagTreeNode, the `icon` value is `lib_application_call`.
'
maxLength: 128
minLength: 0
label:
type: string
description: 'The name of the tagTreeNode. Eg: `Commonly Used`, `Application`.'
maxLength: 128
minLength: 0
queryable:
type: boolean
scoreBoost:
type: integer
format: int32
description: 'By default it is `null` if it is not set explictily by IBM Instana.
The purpose of this parameter is to rank the tagTree. For eg: some set of tags are frequently used.
Tags under `Commonly used` is frequently used, so it will come up on top of the drop down list of `Query Builder` in `Unbounded Analytics`.
Higher the scoreBoost, higher the ranking.
'
type:
type: string
description: Type would be either `LEVEL` or `TAG` depending on whether the tag has any child tags or not respectively.
required:
- children
- label
Pagination:
type: object
properties:
page:
type: integer
format: int32
description: Page number for a specific page in the results. For example, if you'd like to retrieve the 5th page out of 10 pages, the value would be 5.
minimum: 1
pageSize:
type: integer
format: int32
description: 'Set the number of items you want to return with one query. Eg: if you want to retrieve 10 items, the value would be 10.'
maximum: 200
minimum: 1
TagTreeNode:
type: object
description: Children tags of tagTree
discriminator:
mapping:
LEVEL: '#/components/schemas/TagTreeLevel'
TAG: '#/components/schemas/TagTreeTag'
propertyName: type
properties:
icon:
type: string
label:
type: string
type:
type: string
description: Type would be either `LEVEL` or `TAG` depending on whether the tag has any child tags or not respectively.
GetActivities:
type: object
properties:
order:
$ref: '#/components/schemas/Order'
pagination:
$ref: '#/components/schemas/Pagination'
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
timeFrame:
$ref: '#/components/schemas/TimeFrame'
timeframe:
$ref: '#/components/schemas/TimeFrame'
required:
- order
- pagination
- timeFrame
TagCatalog:
type: object
properties:
tagTree:
type: array
description: 'The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: `Call`.
Consider this as the root of the tree where it has tags as attributes or children.
'
items:
$ref: '#/components/schemas/TagTreeLevel'
tags:
type: array
description: 'List of queryable tags available in a tagTree. Eg: `call.erroneous`.
Consider these tags as attributes of a tagTree. Eg: `Call` tagTree has have `Erroneous`, `Call name`, `Latency` etc as attributes.
'
items:
$ref: '#/components/schemas/Tag'
required:
- tagTree
- tags
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 Metrics
- Website Catalog
- Website Analyze
- Website Configuration
- Mobile App Metrics
- Mobile App Catalog
- Mobile App Analyze
- Mobile App Configuration
- End User Monitoring
- name: Applications
tags:
- Application Metrics
- Application Resources
- Application Catalog
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-business-monitoring-api-openapi.yml