Instana Mobile App Metrics API
The Mobile App Metrics API from Instana — 3 operation(s) for mobile app metrics.
The Mobile App Metrics API from Instana — 3 operation(s) for mobile app metrics.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/instana-mobile-app-metrics-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: support@instana.com
name: © Instana
url: http://instana.com
termsOfService: https://www.instana.com/terms-of-use/
title: Instana REST API documentation Mobile App Metrics API
version: 1.307.1417
x-ibm-ahub-try: true
x-logo:
altText: instana logo
backgroundColor: '#FAFBFC'
url: header-logo.svg
description: Searching for answers and best pratices?
servers:
- description: Instana Backend
url: https://{unit}-{tenant}.instana.io
variables:
tenant:
default: tenant
description: Customer tenant unit
unit:
default: unit
description: Customer tenant name
- description: Instana Self-Hosted Backend
url: https://{domain}
variables:
domain:
default: example.com
description: Customer Self-Hosted domain
tags:
- name: Mobile App Metrics
paths:
/api/mobile-app-monitoring/metrics:
post:
deprecated: true
description: API request to get mobile app monitoring beacon metrics.
operationId: getMobileAppBeaconMetrics
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetMobileAppMetrics'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MobileAppMetricResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get mobile app beacon metrics
tags:
- Mobile App Metrics
x-ibm-ahub-byok: true
/api/mobile-app-monitoring/session{id}{timestamp}:
get:
description: API request to get a mobile app monitoring session.
operationId: getSession
parameters:
- description: Identifier of the session to be retrieved
example: 9CA9E31D-B0F7-40EC-8D32-FE163A6557AE
in: path
name: id
required: true
schema:
type: string
style: matrix
- description: Timestamp of the session to be retrieved
example: 1730595029980
in: path
name: timestamp
required: true
schema:
type: integer
format: int64
style: matrix
responses:
'200':
content:
application/json:
example:
- agentVersion: 1.8.5
mobileAppId: K3bP-bmCRkyimNai9vvq8o
mobileAppLabel: robot-warehouse
timestamp: 1707025019211
clockSkew: 460
ingestionTime: 1707025019670
duration: 0
batchSize: 1
sessionId: 9CA9E31D-B0F7-40EC-8D32-FE163A6557AE
beaconId: 659302486df75422
parentBeaconId: ''
backendTraceId: ''
type: sessionStart
view: Products
customEventName: ''
meta:
feature.testGroup: sigma
userIp: 149.200.0.0
userId: Example user id
userSessionId: ''
userName: Example user name
userEmail: example@example.com
userLanguages:
- ar-JO
useFeatures: []
bundleIdentifier: com.example.shop
appBuild: aba9031kl
appVersion: 1.42.3
platform: iOS
osName: iOS
osVersion: 16.7.1
deviceManufacturer: Apple
deviceModel: iPhone 13
deviceHardware: iPhone14,5
viewportWidth: 320
viewportHeight: 680
carrier: Orange
connectionType: wifi
effectiveConnectionType: 3g
latitude: 31.9555
longitude: 35.9435
accuracyRadius: 20
city: Amman
subdivision: Amman Governorate
subdivisionCode: AM
country: Jordan
countryCode: JO
continent: Asia
continentCode: AS
httpCallUrl: ''
httpCallOrigin: ''
httpCallPath: ''
httpCallMethod: ''
httpCallHeaders: {}
errorCount: 0
errorMessage: ''
errorId: ''
errorType: ''
stackTrace: ''
stackTraceLine: []
parsedStackTrace: ''
schema:
type: array
items:
$ref: '#/components/schemas/MobileAppMonitoringBeacon'
description: OK
'400':
description: Bad request.
'401':
description: Unauthorized access - requires user authentication.
'404':
description: Resource not found.
'500':
description: Internal server error.
security:
- ApiKeyAuth:
- Default
summary: Get mobile app session
tags:
- Mobile App Metrics
x-ibm-ahub-byok: true
/api/mobile-app-monitoring/v2/metrics:
post:
description: API request to get mobile app monitoring beacon metrics.
operationId: getMobileAppBeaconMetricsV2
requestBody:
content:
application/json:
example:
metrics:
- metric: beaconCount
aggregation: SUM
granularity: 60
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.view.name
operator: EQUALS
entity: NOT_APPLICABLE
value: Products
timeFrame:
to: null
windowSize: 3600000
type: SESSION_START
schema:
$ref: '#/components/schemas/GetMobileAppMetricsV2'
responses:
'200':
content:
application/json:
example:
metrics:
beaconCount.sum.60:
- - 1707026940000
- 75
- - 1707027000000
- 75
adjustedTimeframe:
windowSize: 3540000
to: 1707030480000
schema:
$ref: '#/components/schemas/MetricAPIResult'
description: OK
'401':
description: Unauthorized access - requires user authentication.
'500':
description: Internal server error.
security:
- ApiKeyAuth:
- Default
summary: Get beacon metrics
tags:
- Mobile App Metrics
x-ibm-ahub-byok: true
components:
schemas:
TagFilterExpressionElement:
type: object
description: Boolean expression of tag filters to define the scope of relevant calls.
discriminator:
mapping:
EXPRESSION: '#/components/schemas/TagFilterExpression'
TAG_FILTER: '#/components/schemas/TagFilter'
propertyName: type
properties:
type:
type: string
required:
- type
GetMobileAppMetrics:
type: object
properties:
metrics:
type: array
items:
$ref: '#/components/schemas/MobileAppMonitoringMetricsConfiguration'
maxItems: 5
minItems: 1
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:
- metrics
- type
TimeFrame:
type: object
description: Time range for which the data should be retrieved.
properties:
to:
type: integer
format: int64
description: 'end of timeframe expressed as the Unix epoch time in milliseconds. Eg: `ISO 8601` standard time `2024-06-27T05:05:55.615Z` can be represented as `1719464755615` in Unix epoch time in milliseconds.'
windowSize:
type: integer
format: int64
description: windowSize in milliseconds
maximum: 2678400000
minimum: 0
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
GetMobileAppMetricsV2:
type: object
properties:
metrics:
type: array
items:
$ref: '#/components/schemas/MobileAppMonitoringMetricsConfiguration'
maxItems: 5
minItems: 1
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
timeFrame:
$ref: '#/components/schemas/TimeFrame'
type:
type: string
enum:
- SESSION_START
- HTTP_REQUEST
- CRASH
- CUSTOM
- VIEW_CHANGE
- DROP_BEACON
- PERF
required:
- metrics
- type
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
MetricAPIResult:
type: object
properties:
adjustedTimeframe:
$ref: '#/components/schemas/AdjustedTimeframe'
metrics:
type: object
additionalProperties:
type: array
items:
type: array
items:
type: number
required:
- metrics
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
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
MobileAppMonitoringMetricsConfiguration:
type: object
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`.'
numeratorTagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
required:
- aggregation
- metric
MobileAppMetricResult:
type: object
properties:
empty:
type: boolean
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