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 Application Analyze 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: Application Analyze
  description: "The API endpoints of this group expose our analyze functionality.\nIt includes:\n\n**Grouped Metrics**\n\nTwo group endpoints to retrieve metrics for traces and calls. \n\n**List of traces and its detailed information**\n\nYou can also [search and filter all traces](#operation/getTraces) and retrieve [all details](#operation/getTraceDownload) attached to the trace. Furthermore, you can also retrive [all details](#operation/getCallDetails) of a call.\n\n## Parameters\n### Mandatory Parameters (only for group Endpoints):\n**group** It is mandatory to select a tag by which the calls and traces are grouped for the distinct endpoint call\n* *groupByTag* select a tag by which the calls and traces are grouped \n  * a full list of available tags can be retrieved from the [application tag catalog](#operation/getApplicationTagCatalog)\n  * for the trace endpoint only two tags are reasonable and working: `trace.endpoint.name` and `trace.service.name` which indicate the entry endpoint or service for the trace\n* *groupByTagSecondLevelKey* tags of type KEY_VALUE_PAIR need a second parameter e.g for `kubernetes.deployment.label` you would need provide the label you want to groupBy here.\n\n### Optional Parameters\n**pagination**\n* *offset* set the starting point for the data retrieval\n* *retrievalSize* you set the number of returned values\n* *ingestionTime* if you want to paginate through your result set you are interested in having the data for a fixed time point, the results set has a `cursor` class that has a ingestionTime property that indicates what you have to enter here.\n**order**\n\n**timeFrame** As in our UI you can specify the timeframe for metrics retrieval.\n```\n  windowSize           to\n     (ms)       (unix-timestamp)\n<----------------------|\n```\nThe timeFrame might be adjusted to fit the metric granularity so that there is no partial bucket. For example, if the query timeFrame is 08:02 - 09:02 and the metric granularity is 5 minutes, the timeFrame will be adjusted to 08:05 - 09:00. The adjusted timeFrame will be returned in the response payload. If the query does not have any metric with granularity, a default granularity will be used for adjustment.\n\n**tagFilters** As in the UI you able to filter your query by a tag. To get a list of all available tags you can query the [application tag catalog](#operation/getApplicationTagCatalog)\n* *name* The name of the tag as returned by the catalog\n* *value* The filter value of the tag, possible types are:\n  * \"STRING\" alphanumerical values, valid operators: \"EQUALS\", \"CONTAINS\", \"NOT_EQUAL\", \"NOT_CONTAIN\", \"NOT_EMPTY\",  \"IS_EMPTY\"\n  * \"NUMBER\" numerical values, valid operators: \"EQUALS\", \"LESS_THAN\" \"GREATER_THAN\"\n  * \"KEY_VALUE_PAIR\" \n* *operator* one of the valid operators for the type of the selected tag\n\n**metrics** A list of metric objects that define which metric should be returned, with the defined aggregation. Each metrics objects consists of minimum two items:\n1. *metric* select a particular metric, available metrics in this context are\n   * Latency Mean\n   * Error Rate\n   * Traces Sum\n2. *aggregation* depending on the selected metric different aggregations are available e.g. SUM, MEAN, P95. The aforementioned [catalog endpoint](#operation/getApplicationCatalogMetrics) gives you the metrics with the available aggregations.\n\n**Note**: The above mentioned list of available metrics with its supported metrics can also be found in [Get grouped call metrics](#operation/getCallGroup) and [Get grouped trace metrics](#operation/getTraceGroups).\n\n3. *granularity* \n   * If it is not set you will get a an aggregated value for the selected timeframe\n   * If the granularity is set you will get data points with the specified granularity **in seconds**\n    * The granularity should not be greater than the `windowSize` (important: `windowSize` is expressed in **milliseconds**)\n    * The granularity should not be set too small relative to the `windowSize` to avoid creating an excessively large number of data points (max 600)\n\n### Defaults:\n**timeFrame**\n```\n\"timeFrame\": {\n\t\"windowSize\": 60000,\n\t\"to\": {current timestamp}\n}\n```\n"
paths:
  /api/application-monitoring/analyze/backend-correlation:
    get:
      description: 'Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.

        For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.'
      operationId: getCorrelatedTraces
      parameters:
      - description: 'Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring.

          For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`.

          '
        example: 0v7f55879ca12345
        in: query
        name: correlationId
        required: true
        schema:
          type: string
          maxLength: 128
          minLength: 0
      responses:
        '200':
          content:
            application/json:
              example:
              - traceId: c606ccf3578135c6
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackendTraceReference'
          description: OK
      security:
      - ApiKeyAuth:
        - Default
      summary: Resolve Trace IDs from Monitoring Beacons.
      tags:
      - Application Analyze
      x-ibm-ahub-byok: true
  /api/application-monitoring/analyze/call-groups:
    post:
      operationId: getCallGroup
      parameters:
      - description: If enabled, fill the missing data points in the metric result with timestamp and value 0.
        in: query
        name: fillTimeSeries
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            example:
              group:
                groupbyTag: service.name
                groupbyTagEntity: DESTINATION
              metrics:
              - aggregation: SUM
                metric: calls
              - aggregation: P75
                metric: latency
                granularity: 360
              includeInternal: false
              includeSynthetic: false
              order:
                by: calls
                direction: DESC
              pagination:
                retrievalSize: 20
              tagFilterExpression:
                type: EXPRESSION
                logicalOperator: AND
                elements:
                - type: TAG_FILTER
                  name: call.type
                  operator: EQUALS
                  entity: NOT_APPLICABLE
                  value: DATABASE
                - type: TAG_FILTER
                  name: service.name
                  operator: EQUALS
                  entity: DESTINATION
                  value: ratings
              timeFrame:
                to: '1688366990000'
                windowSize: '600000'
            schema:
              $ref: '#/components/schemas/GetCallGroups'
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                - name: ratings
                  timestamp: 1688366520000
                  cursor:
                    '@class': .IngestionOffsetCursor
                    ingestionTime: 1688980829000
                    offset: 1
                  metrics:
                    latency.p75.360:
                    - - 1688366520000
                      - 1
                canLoadMore: false
                totalHits: 1
                totalRepresentedItemCount: 1
                totalRetainedItemCount: 1
                adjustedTimeframe:
                  windowSize: 360000
                  to: 1688366880000
              schema:
                $ref: '#/components/schemas/CallGroupsResult'
          description: OK
      security:
      - ApiKeyAuth:
        - Default
      summary: Get grouped call metrics
      tags:
      - Application Analyze
      x-ibm-ahub-byok: true
      description: "This endpoint retrieves the metrics for calls.\r\n\r\n## Deprecated Parameters\r\n**tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.\r\n\r\n## Supported Aggregation on Get Grouped call metrics\r\n\r\n| Metric           | Description                                                                                | Allowed Aggregations |\r\n|------------------|--------------------------------------------------------------------------------------------|----------------------|\r\n| `calls`          | Number of received calls                                                                   | `PER_SECOND`, `SUM`  |\r\n| `erroneousCalls` | The number of erroneous calls                                                              |`PER_SECOND`, `SUM`   |\r\n| `latency`        | Latency of received calls in milliseconds                                                  | `P25`, `P50`, `P75`, `P90`, `P95`, `P98`, `P99`, `SUM`, `MEAN`, `MAX`, `MIN`        |\r\n| `errors`         | Error rate of received calls. A value between 0 and 1                                      | `MEAN`               |\r\n| `services`       | The number of Services                                                                     |`DISTINCT_COUNT`      |"
  /api/application-monitoring/analyze/trace-groups:
    post:
      operationId: getTraceGroups
      parameters:
      - description: If enabled, fill the missing data points in the metric result with timestamp and value 0.
        in: query
        name: fillTimeSeries
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            example:
              group:
                groupbyTag: trace.endpoint.name
                groupbyTagEntity: NOT_APPLICABLE
              metrics:
              - aggregation: SUM
                metric: latency
              order:
                by: latency
                direction: ASC
              pagination:
                retrievalSize: 20
              tagFilterExpression:
                type: EXPRESSION
                logicalOperator: AND
                elements:
                - type: TAG_FILTER
                  name: call.type
                  operator: EQUALS
                  entity: NOT_APPLICABLE
                  value: DATABASE
                - type: TAG_FILTER
                  name: service.name
                  operator: EQUALS
                  entity: DESTINATION
                  value: ratings
            schema:
              $ref: '#/components/schemas/GetTraceGroups'
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                - name: GET /api/cart-total
                  timestamp: 1688542673148
                  cursor:
                    '@class': .IngestionOffsetCursor
                    ingestionTime: 1688543264000
                    offset: 1
                  metrics:
                    latency.sum:
                    - - 1688543260000
                      - 31
                canLoadMore: true
                totalHits: 2595
                totalRepresentedItemCount: 2595
                totalRetainedItemCount: 2595
                adjustedTimeframe:
                  windowSize: 600000
                  to: 1687939110000
              schema:
                $ref: '#/components/schemas/TraceGroupsResult'
          description: OK
      security:
      - ApiKeyAuth:
        - Default
      summary: Get grouped trace metrics
      tags:
      - Application Analyze
      x-ibm-ahub-byok: true
      description: "The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name.\n\nThe supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`. \n\n## Supported Aggregation on Get grouped trace metrics\n\n| Metric           | Description                                                                                | Allowed Aggregations |\n|------------------|--------------------------------------------------------------------------------------------|----------------------|\n| `erroneousCalls` | The number of erroneous calls                                                              |`PER_SECOND`, `SUM`   |\n| `latency`        | Latency of received calls in milliseconds                                                  | `P25`, `P50`, `P75`, `P90`, `P95`, `P98`, `P99`, `SUM`, `MEAN`, `MAX`, `MIN`        |\n| `errors`         | Error rate of received calls. A value between 0 and 1                                      | `MEAN`               |\n"
  /api/application-monitoring/analyze/traces:
    post:
      operationId: getTraces
      requestBody:
        content:
          application/json:
            examples:
              analyze/traces:
                description: analyze/traces
                value:
                  includeInternal: false
                  includeSynthetic: false
                  pagination:
                    retrievalSize: 1
                  tagFilterExpression:
                    type: EXPRESSION
                    logicalOperator: AND
                    elements:
                    - type: TAG_FILTER
                      name: endpoint.name
                      operator: EQUALS
                      entity: DESTINATION
                      value: GET /
                    - type: TAG_FILTER
                      name: service.name
                      operator: EQUALS
                      entity: DESTINATION
                      value: groundskeeper
                  order:
                    by: traceLabel
                    direction: DESC
            schema:
              $ref: '#/components/schemas/GetTraces'
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                - trace:
                    id: 506aef767d8ec147
                    label: sdk.reloading-config-cache
                    startTime: 1725601763937
                    duration: 0
                    erroneous: false
                    service:
                      id: 84b5041665ce4ed6f60b47d1fd96c12d4132c9ed
                      label: appdata-processor
                      types: []
                      technologies: []
                      snapshotIds: []
                      entityType: SERVICE
                    endpoint: null
                  cursor:
                    '@class': .IngestionOffsetCursor
                    ingestionTime: 1725601787000
                    offset: 1
                canLoadMore: true
                totalHits: 154
                totalRepresentedItemCount: 154
                totalRetainedItemCount: 154
                adjustedTimeframe:
                  windowSize: 600000
                  to: 1725601780000
              schema:
                $ref: '#/components/schemas/TraceResult'
          description: OK
          x-example: TraceResult
      security:
      - ApiKeyAuth:
        - Default
      summary: Get all traces
      tags:
      - Application Analyze
      x-ibm-ahub-byok: true
      description: "Use the endpoint to retrieve a list of traces.\r\n\r\n**Deprecated Parameter:** `tagFilters` is deprecated. It is replaced by `tagFilterExpression`.\r\n"
  /api/application-monitoring/v2/analyze/traces/{id}:
    get:
      description: 'Use this API endpoint if one wants to retrive comprehensive details of a particular trace.

        For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.'
      operationId: getTraceDownload
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          description: An Instana generated unique identifier for a trace.
      - in: query
        name: retrievalSize
        schema:
          type: integer
          format: int32
          description: 'The number of records to retrieve in a single request.

            For example, when retrievalSize is set to 30, offset is 20, and ingestionTime is 1725519793, the API request will fetch 30 records starting from the 21st record after the specified `ingestionTime`.

            Minimum value is 1 and maximum value is 10000.

            '
          maximum: 10000
          minimum: 1
      - in: query
        name: offset
        schema:
          type: integer
          format: int32
          description: 'The number of records to be skipped from the `ingestionTime`.

            For example: when `offset` is 20 and `ingestionTime` is 1725519793, the API response should have records starting from the 21st record after the specified `ingestionTime`.

            Note that if `offset` value is not empty, `ingestionTime` can''t be empty.

            '
      - in: query
        name: ingestionTime
        schema:
          type: integer
          format: int64
          description: 'The timestamp indicating the starting point from which data was ingested.

            The format of the timestamp is in Unix epoch Time.

            For example, `Thursday, 5 September 2024 07:03:13 GMT` can be represented as `1725519793`.

            '
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                - id: daa9141549aea210
                  timestamp: 1688544599223
                  parentId: null
                  foreignParentId: null
                  name: GET /api/shipping/cities/dk
                  duration: 30
                  minSelfTime: 1
                  networkTime: null
                  callCount: 1
                  errorCount: 0
                  destination:
                    service:
                      id: ce4b152bac7b99744d8314838e49b799afd6dd96
                      label: nginx-web
                    endpoint:
                      id: wAS2omB44e0EK4xqL7f-e-wt4C4
                      label: upstream shipping
                      type: HTTP
                    technologies: []
                  cursor:
                    '@class': .IngestionOffsetCursor
                    ingestionTime: 1688547327000
                    offset: 1
                canLoadMore: false
                totalHits: 3
                totalRepresentedItemCount: 3
                totalRetainedItemCount: 3
              schema:
                $ref: '#/components/schemas/TraceDownloadResult'
          description: OK
      security:
      - ApiKeyAuth:
        - Default
      summary: Get trace detail
      tags:
      - Application Analyze
      x-ibm-ahub-byok: true
  /api/application-monitoring/v2/analyze/traces/{traceId}/calls/{callId}/details:
    get:
      description: 'Use this API endpoint to retrieve a vast information about a call present in a trace.


        For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.'
      operationId: getCallDetails
      parameters:
      - in: path
        name: traceId
        required: true
        schema:
          type: string
          description: An Instana generated unique identifier for a trace.
      - in: path
        name: callId
        required: true
        schema:
          type: string
          description: 'The call ID. A unique identifier for an individual call. For example: `1bcad5c82338deaf`.'
      responses:
        '200':
          content:
            application/json:
              example:
                id: 14219b3deb6a6bc5
                label: GET /api/shipping/cities/bg
                start: 1707295859759
                duration: 3597
                minSelfTime: 2
                networkTime: null
                errorCount: 0
                batchSize: 1
                batchSelfTime: 3597
                source:
                  applications: []
                  service:
                    id: ROOT
                    label: ''
                  endpoint:
                    id: XCjGvnwuiak0m3ISke3naE-NrGA
                    label: Unspecified
                    type: UNDEFINED
                  physicalContext: {}
                destination:
                  applications: []
                  service:
                    id: ce4b152bac7b99744d8314838e49b799afd6dd96
                    label: nginx-web
                  endpoint:
                    id: wAS2omB44e0EK4xqL7f-e-wt4C4
                    label: upstream shipping
                    type: HTTP
                  physicalContext:
                    process:
                      id: jXvrnXHuBqfhlZQTux-ck1PYd6Y
                      time: 1707258023000
                      label: Node @30303
                      plugin: nginx
                      data: null
                spans:
                - id: 14219b3deb6a6bc5
                  parentId: ''
                  name: sdk.http.entry
                  kind: ENTRY
                  foreignParentId: ''
                  start: 1707295859759
                  duration: 3597
                  errorCount: 0
                  stackTrace: []
                  data:
                    service: nginx-web
                    http:
                      path: /api/shipping/cities/bg
                      protocol: http
                      route_id: upstream shipping
                      method: GET
                      host: web:8080
                      url: http://web:8080//api/shipping/cities/bg
                      status: 200
                logs: []
                synthetic: false
              schema:
                $ref: '#/components/schemas/TraceActivityTreeNodeDetails'
          description: OK
      security:
      - ApiKeyAuth:
        - Default
      summary: Get call detail
      tags:
      - Application Analyze
      x-ibm-ahub-byok: true
components:
  schemas:
    GetTraceGroups:
      type: object
      properties:
        group:
          $ref: '#/components/schemas/Group'
        includeInternal:
          type: boolean
          description: Flag to include Internal Calls. These calls are work done inside a service and correspond to intermediate spans in custom tracing.
        includeSynthetic:
          type: boolean
          description: Flag to include Synthetic Calls. These calls have a synthetic endpoint as their destination, such as calls to health-check endpoints.
        metrics:
          type: array
          description: 'A list of objects each of which defines a metric and the (statistical) aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': ''MEAN''}]`. To know more about supported metrics and its aggregation, See `Get Metric catalog`.'
          items:
            $ref: '#/components/schemas/MetricConfig'
          maxItems: 5
          minItems: 1
        order:
          $ref: '#/components/schemas/Order'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        tagFilterExpression:
          $ref: '#/components/schemas/TagFilterExpressionElement'
        tagFilters:
          type: array
          items:
            $ref: '#/components/schemas/DeprecatedTagFilter'
          maxItems: 32
          minItems: 0
        timeFrame:
          $ref: '#/components/schemas/TimeFrame'
      required:
      - group
      - metrics
    GetCallGroups:
      type: object
      properties:
        group:
          $ref: '#/components/schemas/Group'
        includeInternal:
          type: boolean
          description: Flag to include Internal Calls. These calls are work done inside a service and correspond to intermediate spans in custom tracing.
        includeSynthetic:
          type: boolean
          description: Flag to include Synthetic Calls. These calls have a synthetic endpoint as their destination, such as calls to health-check endpoints.
        metrics:
          type: array
          description: 'A list of objects each of which defines a metric and the (statistical) aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': ''MEAN''}]`. To know more about supported metrics and its aggregation, See `Get Metric catalog`.'
          items:
            $ref: '#/components/schemas/MetricConfig'
          maxItems: 5
          minItems: 1
        order:
          $ref: '#/components/schemas/Order'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        tagFilterExpression:
          $ref: '#/components/schemas/TagFilterExpressionElement'
        tagFilters:
          type: array
          items:
            $ref: '#/components/schemas/DeprecatedTagFilter'
          maxItems: 10
          minItems: 0
        timeFrame:
          $ref: '#/components/schemas/TimeFrame'
      required:
      - group
      - metrics
    Trace:
      type: object
      description: '1. `service`: The service from where trace started.

        2. `endpoint`: Endpoint of the service.

        '
      properties:
        duration:
          type: integer
          format: int64
          description: Total time taken for a trace to finish.
          minimum: 0
        endpoint:
          $ref: '#/components/schemas/Endpoint'
        erroneous:
          type: boolean
          description: Flag which tells whether the trace is erroneous or not
        id:
          type: string
          description: The trace ID. All spans of the same trace must have the same trace ID. For example, `e93282c0d5018320`.
        label:
          type: string
          description: Name of the trace.
        service:
          $ref: '#/components/schemas/Service'
        startTime:
          type: integer
          format: int64
          description: The start time of the trace.
          minimum: 1
      required:
      - id
      - label
    KubernetesPhysicalContext:
      type: object
      description: Contains physical context of Kubernetes which contains information about the cluster, namespace, node and pod.
      properties:
        cluster:
          $ref: '#/components/schemas/SnapshotPreview'
        namespace:
          $ref: '#/components/schemas/SnapshotPreview'
        node:
          $ref: '#/components/schemas/SnapshotPreview'
        pod:
          $ref: '#/components/schemas/SnapshotPreview'
    SpanRelation:
      type: object
      description: 'It shows from where the call is destined to. It includes the following information:

        1. List of Application Perspectives from which the call is destined to.

        2. Destination service and destination endpoint.

        3. Physical context from the infrastructure point of view.

        '
      properties:
        applications:
          type: array
          items:
            $ref: '#/components/schemas/Application'
          uniqueItems: true
        endpoint:
          $ref: '#/components/schemas/Endpoint'
        physicalContext:
          $ref: '#/components/schemas/PhysicalContext'
        service:
          $ref: '#/components/schemas/Service'
      required:
      - applications
    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
    SnapshotPreview:
      type: object
      properties:
        data:
          type: object
          additionalProperties:
            type: object
            description: Subset of the data section of the plugin. In most cases this field will be null.
          description: Subset of the data section of the plugin. In most cases this field will be null.
        id:
          type: string
          description: This is a snapshot ID. A unique identifier the metrics are assigned to.
        label:
          type: string
          description: Name of the entity.
        plugin:
          type: string
          description: A short plugin ID. For example, `containerd`, `nginx` etc.
        time:
          type: integer
          format: int64
          description: Specifies the exact point at which the id, label and plugin are valid.
          minimum: 1
      required:
      - id
    TraceActivityTreeNodeDetails:
      type: object
      properties:
        batchSelfTime:
          type: integer
          format: int64
          description: 'Sum of all self times in a batch of calls.

            For example, if 5 calls are in a batch and its self times are : `[1,2,3,4,5]` in milliseconds, then the batch self time would be sum of the self times,

            in this case, it will be 15 milliseconds.

            '
        batchSize:
          type: integer
          format: int32
          description: Number of calls in a batch.
          minimum: 0
        destination:
          $ref: '#/components/schemas/SpanRelation'
        duration:
          type: integer
          format: int64
          description: The total time taken for the entire operation of a call, from the moment the request was initiated to when the response was received. The time measured is in milliseconds. This is also known as latency of a call.
          minimum: 0
        errorCount:
          type: integer
          format: int32
          description: Represents whether the call is erroneous or not. 0 is not erroneous and 1 is erroneous.
          minimum: 0
        id:
          type: string
          description: 'The call ID. A unique identifier for an individual call. For example: `1bcad5c82338deaf`.'
        isSynthetic:
          type: boolean
          writeOnly: true
        label:
          type: string
          description: 'Name of the call. For example: `GET /articles/:id`.'
          maxLength: 128
          minLength: 0
        logs:
          type: array
          description: Information about the logs attached to the call, if available.
          items:
            $ref: '#/components/schemas/SpanExcerpt'
          uniqueItems: true
        minSelfTime:
          type: integer
          format: int64
          description: The smallest self time in the batch. May be null to indicate that `minSelfTime` is unknown when this node has only an exit span and no children. The time measured is in milliseconds.
        networkTime:
          type: integer
          format: int64
          description: The time difference between the Exit Span Time of the caller and the Entry Span Time of the call. This value is measured in milliseconds and may be null if network time is not applicable.
        rawSpanLoadError:
          type: string
          description: Whether an error occurred loading raw spans from external storage.
          enum:
          - UNKNOWN_ERROR
          - NOT_FOUND
          - PERMISSION_DENIED
          - NO_ERROR
        source:
          $ref: '#/components/schemas/SpanRelation'
        spans:
          type: array
          description: Information about the spans from which the call is composed.
          items:
            $ref: '#/components/schemas/SpanExcerpt'
          maxItems: 2
          minItems: 1
          uniqueItems: true
        start:
          type: integer
          format: int64
          description: The timestamp when the call or request was initiated. For example, Unix epoch time in milliseconds `1735532879870` is `Monday, 30 December 2024 04:27:59.870 GMT`
          minimum: 1
        synthetic:
          type: boolean
      required:
      - id
      - label
      - logs
      - spans
    AdjustedTimeframe:
      type: object
      description: 'Time frame provided in API request is slightly adjusted in response for faster API response.

        For example, In request payload, if timeframe is 08:03 - 14:03, which is a 6 hour window size. It is adjusted to 08:05 - 14:00

        Another example, In request payload, if timeframe is 08:20 - 08:20 (next day) which is a 24h window size. It is adjusted to 08:30 - 08:00 (next day)

        '
      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
          minimum: 0
      required:
      - to
    SpanExcerpt:
      type: object
      description: Information about the logs attached to the call, if available.
      properties:
        data:
          type: object
          additionalProperties:
            type: object
            description: Some information about the span, like service name, if it is an http call, then some information about it like, path, method, host, errors etc.
          description: Some information about the span, like service name, if it is an http call, then some information about it like, path, method, host, errors etc.
        databaseIntegrations:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseIntegration'
        duration:
          type: integer
          format: int64
          description: The total time taken for the entire operation of a call, from the moment the request was initiated to when the response was received. The time measured is in milliseconds. This is also known as latency of a call.
          minimum: 0
        errorCount:
          type: integer
          format: int32
          description: Represents whether the span is erroneous or not. 0 is not erroneous and 1 is erroneous.
          minimum: 0
        foreignParentId:
          type: string
        id:
          type: string
          description: 'The call ID. A unique identifier for an individual call. For example: `1bcad5c82338deaf`.'
        kind:
          type: string
          description: 'There are 4 types of span kind:

            1. `ENTRY`: An entry span represents an incoming request into a traced service.

            2. `EXIT`: An exit span represents an outgoing request that a service makes to some other service.

            3. `INTERMEDIATE`: An intermediate span represents anything that happens inside a traced service where the flow of control neither enters nor leaves that service, but stays inside it.

            4. `UNKNOWN`: Instana can''t determine the span kind.

            '
          enum:
          - UNKNOWN
          - ENTRY
          - EXIT
          - INTERMEDIATE
        name:
          type: string
          description: The technical type of the span. For example, `node.http.client` or `jdbc`.
        parentId:
          type: string
          description: The parent call id, referring to another call in the same trace which triggered the processing associated with this call.
        stackTrace:
          type: array
          description: For an erroneous call, if stack trace is available it will show a list of items containing file, method and line number of the code.
          items:
            $ref: '#/components/schemas/StackTraceItem'
        start:
          type: integer
          format: int64
          description: The timestamp when the call or request was initiated. For example, Unix epoch time in milliseconds `1735532879870` is `Monday, 30 December 2024 04:27:59.870 GMT`
          minimum: 1
      required:
      - data
      - id
      - kind
      - name
      - stackTrace
    MetricConfig:
      type: object
      description: 'A list of objects each of which defines a metric and the (statistical) aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': ''MEAN''}]`. To know more about supported metrics and its aggregation, See `Get Metric catalog`.'
      properties:
        aggregation:
          type: string
          description: 'Set aggregation that can be applied to a series of values. Eg: `MEAN`.'
          enum:
          - SUM
          - MEAN
          - MAX
          - MIN
          - P25
          - P50
          - P75
          - P90
          - P95
          - P98
          - P99
          - P99_9
          - P99_99
          - DISTINCT_COUNT
          - SUM_POSITIVE
          - PER_SECOND
          - INCREASE
        granularity:
          type: integer
          format: int32
          description: 'If the granularity is set you will get data points with the specified granularity in seconds. Default: `1000` milliseconds'
        metric:
          type: string
          description: 'Set a particular metric, eg: `latency`.'
      required:
      - aggregation
      - metric
    DatabaseIntegration:
      type: object
      properties:
        type:
          type: string
        url:
          type: string
    CallGroupsItem:
      type: object
      description: 'Represents an array of call group item containing several attributes that describe its properties.

        The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

        '
      properties:
        cursor:
          $ref: '#/components/schemas/IngestionOffsetCursor'
        metrics:
          type: object
          additionalProperties:
            type: array
            description: 'Grouped metric details like `errors.mean`, `calls.sum`.

              It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

              Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

              '
            items:
              type: array
              description: 'Grouped metric details like `errors.mean`, `calls.sum`.

                It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

                Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

                '
              items:
                type: number
                description: 'Grouped metric details like `errors.mean`, `calls.sum`.

                  It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

                  Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

                  '
          description: 'Grouped metric details like `errors.mean`, `calls.sum`.

            It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

            Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

            '
        name:
          type: string
          description: Name of the group.
        timestamp:
          type: integer
          format: int64
          description: Earliest timestamp of the call from the group
          minimum: 0
      required:
      - cursor
      - metrics
      - name
    GetTraces:
      type: object
      properties:
        includeInternal:
          type: boolean
          description: Flag to include Internal Calls. These calls are work done inside a service and correspond to intermediate spans in custom tracing.
        includeSynthetic:
          type: boolean
          description: Flag to include Synthetic Calls. These calls have a synthetic endpoint as their destination, such as calls to health-check endpoints.
        order:
          $ref: '#/components/schemas/Order'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        tagFilterExpression:
          $ref: '#/components/schemas/TagFilterExpressionElement'
        tagFilters:
          type: array
          items:
            $ref: '#/components/schemas/DeprecatedTagFilter'
          maxItems: 32
          minItems: 0
        timeFrame:
          $ref: '#/components/schemas/TimeFrame'
    Group:
      type: object
      description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.'
      properties:
        groupbyTag:
          type: string
          description: The name of the group tag (e.g. `agent.tag` or `docker.label`).
          maxLength: 256
          minLength: 0
        groupbyTagEntity:
          type: string
          description: 'The entity by which the data should be grouped.

            This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`.

            `SOURCE`: the tag filter should apply to the source entity.

            `DESTINATION`: the tag filter should apply to the destination entity.

            `NOT_APPLICABLE`: some tags are independent of source or destination, such as tags on the call itself, log tags or trace tags (only destination makes sense because the source is unknown for the root call).

            '
          enum:
          - NOT_APPLICABLE
          - DESTINATION
          - SOURCE
        groupbyTagSecondLevelKey:
          type: string
          description: If present, it's the 2nd level key part (e.g. `customKey` on `docker.label.customKey`)
          maxLength: 256
          minLength: 0
      required:
      - groupbyTag
      - groupbyTagEntity
    TraceGroupsResult:
      type: object
      properties:
        adjustedTimeframe:
          $ref: '#/components/schemas/AdjustedTimeframe'
        canLoadMore:
          type: boolean
          description: Determine if additional data is available when a new query is made using the cursor from the last item in the `items` list.
        items:
          type: array
          description: 'Represents an array of call group item containing several attributes that describe its properties.

            The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

            '
          items:
            $ref: '#/components/schemas/TraceGroupsItem'
        totalHits:
          type: integer
          format: int64
          description: The total number of items that match a given filter
          minimum: 0
        totalRepresentedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, one row can represent multiple real items (batched call, sample multiplicity)
          minimum: 0
        totalRetainedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, only a subset is retained for historic data. Each retained row can represent multiple real items due to batching.
          minimum: 0
      required:
      - items
    CallRelation:
      type: object
      description: It shows from where the call is destined to. It includes destination service, its endpoint and list of technologies of the service.
      properties:
        endpoint:
          $ref: '#/components/schemas/EndpointSimple'
        service:
          $ref: '#/components/schemas/ServiceSimple'
        technologies:
          type: array
          description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
          items:
            type: string
            description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
    IngestionOffsetCursor:
      type: object
      description: Cursor to use between successive queries
    GetTraceDownloadResultItem:
      type: object
      description: 'Represents an array of call group item containing several attributes that describe its properties.

        The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

        '
      properties:
        callCount:
          type: integer
          format: int64
          description: Number of calls in a trace.
        cursor:
          $ref: '#/components/schemas/IngestionOffsetCursor'
        destination:
          $ref: '#/components/schemas/CallRelation'
        duration:
          type: integer
          format: int64
          description: The total time taken for the entire operation of a call, from the moment the request was initiated to when the response was received. The time measured is in milliseconds. This is also known as latency of a call.
        errorCount:
          type: integer
          format: int64
          description: Represents whether the call is erroneous or not. 0 is not erroneous and 1 is erroneous.
        foreignParentId:
          type: string
        id:
          type: string
          description: 'The call ID. A unique identifier for an individual call. For example: `1bcad5c82338deaf`.'
        minSelfTime:
          type: integer
          format: int64
          description: The smallest self time in the batch. May be null to indicate that `minSelfTime` is unknown when this node has only an exit span and no children. The time measured is in milliseconds.
        name:
          type: string
          description: 'Name of the call. For example: `GET /articles/:id`.'
        networkTime:
          type: integer
          format: int64
          description: exit span duration - entry span duration
        parentId:
          type: string
          description: The parent call id, referring to another call in the same trace which triggered the processing associated with this call.
        timestamp:
          type: integer
          format: int64
          description: The timestamp when the call or request was initiated. For example, Unix epoch time in milliseconds `1735532879870` is `Monday, 30 December 2024 04:27:59.870 GMT`
    PhysicalContext:
      type: object
      description: 'The physical context of an entity. This is typically used to describe where a host, container or process fits into the infrastructure.

        1. `cloudfoundry`: Contains physical context of Cloudfoundry.

        2. `cluster`: Contains physical context of cluster like Hazelcast, Elasticsearch.

        3. `container`: Contains physical context of container.

        4. `host`: Contains physical context of host.

        5. `kubernetes`: Contains physical context of Kubernetes.

        6. `process`: Contains physical context of a process.

        '
      properties:
        cloudfoundry:
          $ref: '#/components/schemas/CloudfoundryPhysicalContext'
        cluster:
          $ref: '#/components/schemas/SnapshotPreview'
        container:
          $ref: '#/components/schemas/SnapshotPreview'
        host:
          $ref: '#/components/schemas/SnapshotPreview'
        kubernetes:
          $ref: '#/components/schemas/KubernetesPhysicalContext'
        process:
          $ref: '#/components/schemas/SnapshotPreview'
    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
    DeprecatedTagFilter:
      type: object
      properties:
        entity:
          type: string
          enum:
          - NOT_APPLICABLE
          - DESTINATION
          - SOURCE
        name:
          type: string
        operator:
          type: string
          enum:
          - EQUALS
          - CONTAINS
          - LESS_THAN
          - LESS_OR_EQUAL_THAN
          - GREATER_THAN
          - GREATER_OR_EQUAL_THAN
          - NOT_EMPTY
          - NOT_EQUAL
          - NOT_CONTAIN
          - IS_EMPTY
          - NOT_BLANK
          - IS_BLANK
          - STARTS_WITH
          - ENDS_WITH
          - NOT_STARTS_WITH
          - NOT_ENDS_WITH
          - REGEX_MATCH
        value:
          type: string
      required:
      - name
      - operator
      - value
    CallGroupsResult:
      type: object
      properties:
        adjustedTimeframe:
          $ref: '#/components/schemas/AdjustedTimeframe'
        canLoadMore:
          type: boolean
          description: Determine if additional data is available when a new query is made using the cursor from the last item in the `items` list.
        items:
          type: array
          description: 'Represents an array of call group item containing several attributes that describe its properties.

            The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

            '
          items:
            $ref: '#/components/schemas/CallGroupsItem'
        totalHits:
          type: integer
          format: int64
          description: The total number of items that match a given filter
          minimum: 0
        totalRepresentedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, one row can represent multiple real items (batched call, sample multiplicity)
          minimum: 0
        totalRetainedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, only a subset is retained for historic data. Each retained row can represent multiple real items due to batching.
          minimum: 0
      required:
      - items
    TraceResult:
      type: object
      properties:
        adjustedTimeframe:
          $ref: '#/components/schemas/AdjustedTimeframe'
        canLoadMore:
          type: boolean
          description: Determine if additional data is available when a new query is made using the cursor from the last item in the `items` list.
        items:
          type: array
          description: 'Represents an array of call group item containing several attributes that describe its properties.

            The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

            '
          items:
            $ref: '#/components/schemas/TraceItem'
        totalHits:
          type: integer
          format: int64
          description: The total number of items that match a given filter
          minimum: 0
        totalRepresentedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, one row can represent multiple real items (batched call, sample multiplicity)
          minimum: 0
        totalRetainedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, only a subset is retained for historic data. Each retained row can represent multiple real items due to batching.
          minimum: 0
      required:
      - items
    BackendTraceReference:
      type: object
      properties:
        traceId:
          type: string
          description: 'The corresponding trace ID. For eg: `07eaf10c1d051234` or `000000000000000007eaf10c1d051234`'
      required:
      - traceId
    TraceDownloadResult:
      type: object
      properties:
        adjustedTimeframe:
          $ref: '#/components/schemas/AdjustedTimeframe'
        canLoadMore:
          type: boolean
          description: Determine if additional data is available when a new query is made using the cursor from the last item in the `items` list.
        items:
          type: array
          description: 'Represents an array of call group item containing several attributes that describe its properties.

            The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

            '
          items:
            $ref: '#/components/schemas/GetTraceDownloadResultItem'
        totalHits:
          type: integer
          format: int64
          description: The total number of items that match a given filter
          minimum: 0
        totalRepresentedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, one row can represent multiple real items (batched call, sample multiplicity)
          minimum: 0
        totalRetainedItemCount:
          type: integer
          format: int64
          description: For calls and EUM beacons, only a subset is retained for historic data. Each retained row can represent multiple real items due to batching.
          minimum: 0
      required:
      - items
    TraceGroupsItem:
      type: object
      description: 'Represents an array of call group item containing several attributes that describe its properties.

        The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

        '
      properties:
        cursor:
          $ref: '#/components/schemas/IngestionOffsetCursor'
        metrics:
          type: object
          additionalProperties:
            type: array
            description: 'Grouped metric details like `errors.mean`, `calls.sum`.

              It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

              Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

              '
            items:
              type: array
              description: 'Grouped metric details like `errors.mean`, `calls.sum`.

                It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

                Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

                '
              items:
                type: number
                description: 'Grouped metric details like `errors.mean`, `calls.sum`.

                  It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

                  Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

                  '
          description: 'Grouped metric details like `errors.mean`, `calls.sum`.

            It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`.

            Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`.

            '
        name:
          type: string
          description: Name of the group.
        timestamp:
          type: integer
          format: int64
          description: Earliest timestamp of the trace from the group
          minimum: 0
      required:
      - cursor
      - metrics
      - name
    EndpointSimple:
      type: object
      description: The destination service's endpoint where the call enters.
      properties:
        id:
          type: string
          description: 'Unique ID of the Endpoint. Eg: `NCRq5oYnan5x-PkdTPQwLLUdu5M`.'
        label:
          type: string
          description: 'Name of the Endpoint. Eg: `GET /api/fetch`.'
        type:
          type: string
          description: The type of the Endpoint.
          enum:
          - UNDEFINED
          - RPC
          - EVENT
          - GRAPHQL
          - BATCH
          - SHELL
          - HTTP
          - SDK
          - OPENTELEMETRY
          - INTERNAL
          - DATABASE
          - MESSAGING
          - PAGE
          - PAGE_RESOURCE
    StackTraceItem:
      type: object
      description: For an erroneous call, if stack trace is available it will show a list of items containing file, method and line number of the code.
      properties:
        file:
          type: string
          description: The name of the file where the executed code resides.
        line:
          type: string
          description: The line number within the file where the error was thrown.
        method:
          type: string
          description: The name of the method or function being executed at the time the stack trace item was generated.
    Endpoint:
      type: object
      properties:
        entityType:
          type: string
          description: Since, this is a Endpoint, it will be of type `ENDPOINT`.
          enum:
          - APPLICATION
          - SERVICE
          - ENDPOINT
        id:
          type: string
          description: 'Unique ID of the Endpoint. Eg: `NCRq5oYnan5x-PkdTPQwLLUdu5M`.'
        isSynthetic:
          type: boolean
          writeOnly: true
        label:
          type: string
          description: 'Name of the Endpoint. Eg: `GET /api/fetch`.'
        serviceId:
          type: string
          description: The serviceId this endpoint belongs to.
        synthetic:
          type: boolean
        syntheticType:
          type: string
          enum:
          - NON_SYNTHETIC
          - SYNTHETIC
          - MIXED
        technologies:
          type: array
          description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
          items:
            type: string
            description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
          uniqueItems: true
        type:
          type: string
          description: The type of the Endpoint.
          enum:
          - UNDEFINED
          - RPC
          - EVENT
          - GRAPHQL
          - BATCH
          - SHELL
          - HTTP
          - SDK
          - OPENTELEMETRY
          - INTERNAL
          - DATABASE
          - MESSAGING
          - PAGE
          - PAGE_RESOURCE
      required:
      - id
      - label
      - serviceId
      - technologies
      - type
    TraceItem:
      type: object
      description: 'Represents an array of call group item containing several attributes that describe its properties.

        The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item.

        '
      properties:
        cursor:
          $ref: '#/components/schemas/IngestionOffsetCursor'
        trace:
          $ref: '#/components/schemas/Trace'
      required:
      - cursor
      - trace
    CursorPagination:
      type: object
      description: 'Details for controlling the pagination of the API response.

        This object allows you to define the starting point for retrieving records, how many records to skip, and the size of the result set.

        '
      properties:
        ingestionTime:
          type: integer
          format: int64
          description: 'The timestamp indicating the starting point from which data was ingested.

            The format of the timestamp is in Unix epoch Time.

            For example, `Thursday, 5 September 2024 07:03:13 GMT` can be represented as `1725519793`.

            '
        offset:
          type: integer
          format: int32
          description: 'The number of records to be skipped from the `ingestionTime`.

            For example: when `offset` is 20 and `ingestionTime` is 1725519793, the API response should have records starting from the 21st record after the specified `ingestionTime`.

            Note that if `offset` value is not empty, `ingestionTime` can''t be empty.

            '
        retrievalSize:
          type: integer
          format: int32
          description: 'The number of records to retrieve in a single request.

            For example, when retrievalSize is set to 30, offset is 20, and ingestionTime is 1725519793, the API request will fetch 30 records starting from the 21st record after the specified `ingestionTime`.

            Minimum value is 1 and maximum value is 200.

            '
          maximum: 200
          minimum: 1
    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
    CloudfoundryPhysicalContext:
      type: object
      description: 'Contains physical context of Cloudfoundry. It contains the following information:

        1. `application`: Application running within Cloud Foundry environment.

        2. `cfInstanceIndex`: A unique ID of the container created and managed by Garden in the Cloud Foundry environment.

        3. `organization`: Organization in the Cloud Foundry environment.

        4. `space`: Space within an organization in Cloud Foundry environment.

        '
      properties:
        application:
          $ref: '#/components/schemas/SnapshotPreview'
        cfInstanceIndex:
          type: string
          description: A unique ID of the container created and managed by Garden in the Cloud Foundry environment.
        organization:
          $ref: '#/components/schemas/SnapshotPreview'
        space:
          $ref: '#/components/schemas/SnapshotPreview'
    ServiceSimple:
      type: object
      description: The destination service.
      properties:
        id:
          type: string
          description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.'
        label:
          type: string
          description: 'Name of the Service. Eg: `payment`.'
    Service:
      type: object
      properties:
        entityType:
          type: string
          description: Since, this is a Service, it will be of type `SERVICE`.
          enum:
          - APPLICATION
          - SERVICE
          - ENDPOINT
        id:
          type: string
          description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.'
        label:
          type: string
          description: 'Name of the Service. Eg: `payment`.'
        snapshotIds:
          type: array
          description: A unique identifier the metrics are assigned to.
          items:
            type: string
            description: A unique identifier the metrics are assigned to.
          uniqueItems: true
        technologies:
          type: array
          description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
          items:
            type: string
            description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
          uniqueItems: true
        types:
          type: array
          description: 'Shows types of Endpoints a Service can consist of. It may be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.'
          items:
            type: string
            description: 'Shows types of Endpoints a Service can consist of. It may be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.'
            enum:
            - UNDEFINED
            - RPC
            - EVENT
            - GRAPHQL
            - BATCH
            - SHELL
            - HTTP
            - SDK
            - OPENTELEMETRY
            - INTERNAL
            - DATABASE
            - MESSAGING
            - PAGE
            - PAGE_RESOURCE
          uniqueItems: true
      required:
      - id
      - label
      - snapshotIds
      - technologies
      - types
    Application:
      type: object
      description: Returns a list of Application Perspectives.
      properties:
        boundaryScope:
          type: string
          description: Here, `ALL` Application Boundary Scope is considered.
        entityType:
          type: string
          description: Since, this is an Application Perspective, it will be of type `APPLICATION`.
          enum:
          - APPLICATION
          - SERVICE
          - ENDPOINT
        id:
          type: string
          description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.'
        label:
          type: string
          description: 'Name of the Application Perspective. Eg: `app1`.'
      required:
      - boundaryScope
      - id
      - label
  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
  - Application Analyze
  - Application Settings
  - Application Topology
  - Application Alert Configuration
  - Global Application Alert Configuration
- name: Infrastructure
  tags:
  - Infrastructure Analyze
  - Infrastructure Metrics
  - Infrastructure Resources
  - Infrastructure Catalog
  - Infrastructure Topology
- name: Logging
  tags:
  - Logging Analyze
- name: Synthetic Monitoring
  tags:
  - Synthetic Catalog
  - Synthetic Metrics
  - Synthetic Settings
  - Synthetic Test Playback Results
  - Synthetic Alert Configuration
- name: Logs
  tags:
  - Log Alert Configuration
- name: Events
  tags:
  - Events
  - Event Settings
- name: Automation
  tags:
  - Action Catalog
  - Action History
  - Policies
- name: Service Levels
  tags:
  - SLI Settings
  - SLI Report
  - Apdex Settings
  - Apdex Report
  - Service Levels Objective(SLO) Configurations
  - Service Levels Objective(SLO) Report
  - Service Levels Alert Configuration
  - SLO Correction Configurations
  - SLO Correction Windows
- name: AI Management
  tags:
  - AI Management
- name: Settings
  tags:
  - Custom Dashboards
  - User
  - Groups
  - Teams
  - Roles
  - Audit Log
  - API Token
  - Maintenance Configuration
  - Synthetic Calls
  - Session Settings
  - Automation Settings
  - Authentication
- name: Open Beta Features
  tags:
  - Infrastructure Analyze
- name: Closed Beta Features
  tags:
  - Infrastructure Alert Configuration
- name: Instana
  tags:
  - Releases
  - Host Agent
  - Health
  - Usage