Instana Mobile App Analyze API

The Mobile App Analyze API from Instana — 2 operation(s) for mobile app analyze.

OpenAPI Specification

instana-mobile-app-analyze-api-openapi.yml Raw ↑
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 Mobile App 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: Mobile App Analyze
paths:
  /api/mobile-app-monitoring/analyze/beacon-groups:
    post:
      description: API request to get grouped mobile app beacon metrics.
      operationId: getMobileAppBeaconGroups
      parameters:
      - in: query
        name: fillTimeSeries
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            example:
              metrics:
              - metric: beaconCount
                aggregation: SUM
                granularity: 60
              group:
                groupbyTag: mobileBeacon.view.name
              tagFilterExpression:
                type: EXPRESSION
                logicalOperator: AND
                elements:
                - type: TAG_FILTER
                  name: mobileBeacon.mobileApp.name
                  operator: EQUALS
                  entity: NOT_APPLICABLE
                  value: robot-warehouse
                - type: TAG_FILTER
                  name: mobileBeacon.platform
                  operator: EQUALS
                  entity: NOT_APPLICABLE
                  value: iOS
              timeFrame:
                to: null
                windowSize: 3600000
              type: SESSION_START
            schema:
              $ref: '#/components/schemas/GetMobileAppBeaconGroups'
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                - name: Products
                  earliestTimestamp: 1707023340857
                  cursor:
                    '@class': .IngestionOffsetCursor
                    ingestionTime: 1707026879283
                    offset: 1
                  metrics:
                    beaconCount.sum.60:
                    - - 1707023340000
                      - 47
                    - - 1707023400000
                      - 43
                canLoadMore: false
                totalHits: 1
                totalRepresentedItemCount: 1
                totalRetainedItemCount: 1
                adjustedTimeframe:
                  windowSize: 3540000
                  to: 1707026880000
              schema:
                $ref: '#/components/schemas/MobileAppBeaconGroupsResult'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - Default
      summary: Get grouped beacon metrics
      tags:
      - Mobile App Analyze
      x-ibm-ahub-byok: true
  /api/mobile-app-monitoring/analyze/beacons:
    post:
      description: API request to get all mobile app beacons with matching type.
      operationId: getMobileAppBeacons
      requestBody:
        content:
          application/json:
            example:
              tagFilterExpression:
                entity: NOT_APPLICABLE
                name: mobileBeacon.mobileApp.name
                operator: EQUALS
                value: robot-warehouse
              timeFrame:
                to: null
                windowSize: 60000
              type: SESSION_START
            schema:
              $ref: '#/components/schemas/GetMobileAppBeacons'
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                - beacon:
                    agentVersion: 6.0.22
                    mobileAppId: K3bP-bmCRkyimNai9vvq8o
                    mobileAppLabel: robot-warehouse
                    timestamp: 1707025556799
                    clockSkew: 450
                    ingestionTime: 1707025557248
                    duration: 0
                    batchSize: 1
                    sessionId: B5CB9B35-C822-4101-B192-DC2488924C7F
                    beaconId: c43d78282ee5b5cf
                    parentBeaconId: ''
                    backendTraceId: ''
                    type: sessionStart
                    view: Products
                    customEventName: ''
                    meta:
                      feature.testGroup: beta
                    userIp: 94.134.0.0
                    userId: Example User Id
                    userSessionId: ''
                    userName: Example User Name
                    userEmail: example@example.com
                    userLanguages:
                    - de-DE
                    useFeatures: []
                    bundleIdentifier: com.example.shop
                    appBuild: aba9031kl
                    appVersion: 1.41.4
                    platform: Android
                    osName: Android
                    osVersion: '10'
                    deviceManufacturer: Google
                    deviceModel: Google Pixel 4XL
                    deviceHardware: Google Pixel 4XL
                    viewportWidth: 320
                    viewportHeight: 680
                    carrier: Deutsche Telekom
                    connectionType: wifi
                    effectiveConnectionType: 3g
                    latitude: 50.9865
                    longitude: 6.9304
                    accuracyRadius: 20
                    city: Cologne
                    subdivision: North Rhine-Westphalia
                    subdivisionCode: NW
                    country: Germany
                    countryCode: DE
                    continent: Europe
                    continentCode: EU
                    httpCallUrl: ''
                    httpCallOrigin: ''
                    httpCallPath: ''
                    httpCallMethod: ''
                    httpCallHeaders: {}
                    errorCount: 0
                    errorMessage: ''
                    errorId: ''
                    errorType: ''
                    stackTrace: ''
                    stackTraceLine: []
                    parsedStackTrace: ''
                  cursor:
                    '@class': .IngestionOffsetCursor
                    ingestionTime: 1707025557248
                    offset: 1
                canLoadMore: false
                totalHits: 70
                totalRepresentedItemCount: 70
                totalRetainedItemCount: 70
                adjustedTimeframe:
                  windowSize: 60000
                  to: 1707025560000
              schema:
                $ref: '#/components/schemas/MobileAppBeaconResult'
          description: OK
      security:
      - ApiKeyAuth:
        - Default
      summary: Get all beacons
      tags:
      - Mobile App Analyze
      x-ibm-ahub-byok: true
components:
  schemas:
    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
    MobileAppMonitoringBeacon:
      type: object
      properties:
        accuracyRadius:
          type: integer
          format: int64
          minimum: -1
        agentVersion:
          type: string
          maxLength: 128
          minLength: 0
        appBuild:
          type: string
          maxLength: 128
          minLength: 0
        appVersion:
          type: string
          maxLength: 128
          minLength: 0
        appVersionNumber:
          type: integer
          format: int64
          minimum: -1
        availableMb:
          type: integer
          format: int64
          minimum: -1
        backendTraceId:
          type: string
          maxLength: 128
          minLength: 0
        batchSize:
          type: integer
          format: int64
          minimum: 1
        beaconId:
          type: string
          maxLength: 128
          minLength: 0
        bundleIdentifier:
          type: string
          maxLength: 128
          minLength: 0
        bytesIngested:
          type: integer
          format: int64
        carrier:
          type: string
          maxLength: 256
          minLength: 0
        city:
          type: string
          maxLength: 256
          minLength: 0
        clockSkew:
          type: integer
          format: int64
          minimum: 0
        coldStartTimeMs:
          type: integer
          format: int64
          minimum: -1
        connectionType:
          type: string
          maxLength: 16
          minLength: 0
        continent:
          type: string
          maxLength: 256
          minLength: 0
        continentCode:
          type: string
          maxLength: 64
          minLength: 0
        country:
          type: string
          maxLength: 256
          minLength: 0
        countryCode:
          type: string
          maxLength: 64
          minLength: 0
        currentAppState:
          type: string
          maxLength: 24
          minLength: 0
        customEventName:
          type: string
          maxLength: 256
          minLength: 0
        customMetric:
          type: number
          format: double
        decodedBodySize:
          type: integer
          format: int64
          minimum: -1
        deviceHardware:
          type: string
          maxLength: 128
          minLength: 0
        deviceManufacturer:
          type: string
          maxLength: 128
          minLength: 0
        deviceModel:
          type: string
          maxLength: 128
          minLength: 0
        dropView:
          type: string
          maxLength: 256
          minLength: 0
        duration:
          type: integer
          format: int64
          minimum: 0
        effectiveConnectionType:
          type: string
          maxLength: 16
          minLength: 0
        encodedBodySize:
          type: integer
          format: int64
          minimum: -1
        environment:
          type: string
          maxLength: 256
          minLength: 0
        errorCount:
          type: integer
          format: int64
          minimum: 0
        errorId:
          type: string
          maxLength: 128
          minLength: 0
        errorMessage:
          type: string
          maxLength: 16384
          minLength: 0
        errorType:
          type: string
          maxLength: 1024
          minLength: 0
        googlePlayServicesMissing:
          type: boolean
        hotStartTimeMs:
          type: integer
          format: int64
          minimum: -1
        httpCallHeaders:
          type: object
          additionalProperties:
            type: string
        httpCallMethod:
          type: string
          maxLength: 16
          minLength: 0
        httpCallOrigin:
          type: string
          maxLength: 1024
          minLength: 0
        httpCallPath:
          type: string
          maxLength: 4096
          minLength: 0
        httpCallStatus:
          type: integer
          format: int32
          maximum: 599
          minimum: -1
        httpCallUrl:
          type: string
          maxLength: 4096
          minLength: 0
        ingestionTime:
          type: integer
          format: int64
          minimum: 1
        internalMeta:
          type: object
          additionalProperties:
            type: string
        label:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        maxMb:
          type: integer
          format: int64
          minimum: -1
        meta:
          type: object
          additionalProperties:
            type: string
        mobileAppId:
          type: string
          maxLength: 64
          minLength: 0
        mobileAppLabel:
          type: string
          maxLength: 128
          minLength: 0
        osName:
          type: string
          maxLength: 128
          minLength: 0
        osVersion:
          type: string
          maxLength: 128
          minLength: 0
        parentBeaconId:
          type: string
        parsedStackTrace:
          type: string
          maxLength: 16384
          minLength: 0
        performanceSubtype:
          type: string
          maxLength: 24
          minLength: 0
        platform:
          type: string
          maxLength: 32
          minLength: 0
        rateLimitBeaconType:
          type: string
          maxLength: 128
          minLength: 0
        rateLimitCount:
          type: integer
          format: int64
          minimum: 0
        rateLimitCustomMetricVal:
          type: array
          items:
            type: number
            format: float
        rateLimitTimeMax:
          type: integer
          format: int64
          minimum: 0
        rateLimitTimeMin:
          type: integer
          format: int64
          minimum: 0
        region:
          type: string
          maxLength: 256
          minLength: 0
        rooted:
          type: boolean
        sessionId:
          type: string
          maxLength: 128
          minLength: 0
        stackTrace:
          type: string
          maxLength: 16384
          minLength: 0
        stackTraceKeyChecksum:
          type: string
          maxLength: 128
          minLength: 0
        stackTraceKeyInformation:
          type: string
          maxLength: 1024
          minLength: 0
        stackTraceLine:
          type: array
          items:
            $ref: '#/components/schemas/StackTraceLine'
          maxItems: 128
          minItems: 0
        stackTraceParsingStatus:
          type: integer
          format: int32
          minimum: -1
        subdivision:
          type: string
          maxLength: 256
          minLength: 0
        subdivisionCode:
          type: string
          maxLength: 64
          minLength: 0
        tenant:
          type: string
          maxLength: 256
          minLength: 0
        timestamp:
          type: integer
          format: int64
          minimum: 1
        transferSize:
          type: integer
          format: int64
          minimum: -1
        type:
          type: string
          maxLength: 24
          minLength: 0
        unit:
          type: string
          maxLength: 256
          minLength: 0
        useFeatures:
          type: array
          items:
            type: string
          maxItems: 15
          minItems: 0
        usedMb:
          type: integer
          format: int64
          minimum: -1
        userEmail:
          type: string
          maxLength: 128
          minLength: 0
        userId:
          type: string
          maxLength: 128
          minLength: 0
        userIp:
          type: string
          maxLength: 45
          minLength: 0
        userLanguages:
          type: array
          items:
            type: string
          maxItems: 5
          minItems: 0
        userName:
          type: string
          maxLength: 128
          minLength: 0
        userSessionId:
          type: string
          maxLength: 128
          minLength: 0
        view:
          type: string
          maxLength: 256
          minLength: 0
        viewportHeight:
          type: integer
          format: int32
          minimum: -1
        viewportWidth:
          type: integer
          format: int32
          minimum: -1
        warmStartTimeMs:
          type: integer
          format: int64
          minimum: -1
      required:
      - beaconId
      - mobileAppId
      - performanceSubtype
      - rateLimitBeaconType
      - type
    MobileAppBeaconTagGroup:
      type: object
      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
    StackTraceLine:
      type: object
      properties:
        column:
          type: integer
          format: int32
          minimum: -1
        file:
          type: string
        line:
          type: integer
          format: int32
          minimum: -1
        name:
          type: string
        translationExplanation:
          type: string
        translationStatus:
          type: integer
          format: int32
          minimum: -1
      required:
      - file
    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
    MobileAppBeaconResult:
      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/MobileAppBeaconsItem'
        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
    IngestionOffsetCursor:
      type: object
      description: Cursor to use between successive queries
    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
    GetMobileAppBeacons:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        tagFilters:
          type: array
          items:
            $ref: '#/components/schemas/DeprecatedTagFilter'
          maxItems: 32
          minItems: 0
        timeFrame:
          $ref: '#/components/schemas/TimeFrame'
        type:
          type: string
          enum:
          - SESSION_START
          - HTTP_REQUEST
          - CRASH
          - CUSTOM
          - VIEW_CHANGE
          - DROP_BEACON
          - PERF
      required:
      - type
    MobileAppBeaconsItem:
      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:
        beacon:
          $ref: '#/components/schemas/MobileAppMonitoringBeacon'
        cursor:
          $ref: '#/components/schemas/IngestionOffsetCursor'
        impactedBeaconInfo:
          $ref: '#/components/schemas/ImpactedBeaconInfo'
      required:
      - beacon
      - cursor
    MobileAppBeaconGroupsResult:
      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/MobileAppBeaconGroupsItem'
        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 dat

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-mobile-app-analyze-api-openapi.yml