Skip to content

MobileAppSessionReplayApi.md

Latest commit

 

History

History
244 lines (168 loc) · 9.93 KB

MobileAppSessionReplayApi.md

File metadata and controls

244 lines (168 loc) · 9.93 KB
Raw

instana_client.MobileAppSessionReplayApi

All URIs are relative to https://unit-tenant.instana.io

Method HTTP request Description
get_action_beacons GET /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/action-beacons Get action beacons for a session
get_session_replay_metadata GET /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-metadata Get session replay metadata
get_session_replay_timestamps GET /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-timestamps Get session replay timestamps

get_action_beacons

GetActionBeaconsResult get_action_beacons(mobile_app_id, session_id, cursor=cursor, page_size=page_size)

Get action beacons for a session

Retrieves action beacons (user interactions and events) for a mobile app session. Uses cursor-based pagination with offset cursors. Returns beacons starting from the cursor offset. The pageSize parameter controls the number of items returned (default 100, max 1000). Includes event types, view components, frustration signals, orientation changes, and more.

Example

import instana_client
from instana_client.models.get_action_beacons_result import GetActionBeaconsResult
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.MobileAppSessionReplayApi(api_client)
    mobile_app_id = 'app-456' # str | Mobile app identifier
    session_id = 'session-123' # str | Session identifier
    cursor = 100 # int | Offset cursor for pagination (number of items already retrieved). Omit for first page. (optional)
    page_size = 100 # int | Number of items per page (default: 100, max: 1000) (optional) (default to 100)

    try:
        # Get action beacons for a session
        api_response = api_instance.get_action_beacons(mobile_app_id, session_id, cursor=cursor, page_size=page_size)
        print("The response of MobileAppSessionReplayApi->get_action_beacons:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MobileAppSessionReplayApi->get_action_beacons: %s\n" % e)

Parameters

Name Type Description Notes
mobile_app_id str Mobile app identifier
session_id str Session identifier
cursor int Offset cursor for pagination (number of items already retrieved). Omit for first page. [optional]
page_size int Number of items per page (default: 100, max: 1000) [optional] [default to 100]

Return type

GetActionBeaconsResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request - Invalid mobile app ID, session ID, or pagination parameters -
401 Unauthorized access - requires user authentication. -
403 Forbidden - User doesn't have access to this mobile app -
404 Not Found - Mobile app or session not found -
500 Internal server error. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_session_replay_metadata

GetSessionReplayMetadataResult get_session_replay_metadata(mobile_app_id, session_id, cursor=cursor, page_size=page_size)

Get session replay metadata

Retrieves detailed metadata for session replay captured during a mobile app session. Uses cursor-based pagination with timestamp cursors. Returns metadata within the time window from cursor to cursor + pageSize. The pageSize represents milliseconds (default 20000ms = 20 seconds). Includes all metadata fields such as event type, view components, orientation changes, etc.

Example

import instana_client
from instana_client.models.get_session_replay_metadata_result import GetSessionReplayMetadataResult
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.MobileAppSessionReplayApi(api_client)
    mobile_app_id = 'app-456' # str | Mobile app identifier
    session_id = 'session-123' # str | Session identifier
    cursor = 1234567890 # int | Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards. (optional)
    page_size = 20000 # int | Time window size in milliseconds (default: 20000ms = 20 seconds) (optional) (default to 20000)

    try:
        # Get session replay metadata
        api_response = api_instance.get_session_replay_metadata(mobile_app_id, session_id, cursor=cursor, page_size=page_size)
        print("The response of MobileAppSessionReplayApi->get_session_replay_metadata:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MobileAppSessionReplayApi->get_session_replay_metadata: %s\n" % e)

Parameters

Name Type Description Notes
mobile_app_id str Mobile app identifier
session_id str Session identifier
cursor int Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards. [optional]
page_size int Time window size in milliseconds (default: 20000ms = 20 seconds) [optional] [default to 20000]

Return type

GetSessionReplayMetadataResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request - Invalid mobile app ID, session ID, or pagination parameters -
401 Unauthorized access - requires user authentication. -
403 Forbidden - User doesn't have access to this mobile app -
404 Not Found - Mobile app or session not found -
500 Internal server error. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_session_replay_timestamps

SessionReplayTimestamps get_session_replay_timestamps(mobile_app_id, session_id)

Get session replay timestamps

Retrieves the first and last image timestamps for a mobile app session. Returns null values if the session has no images.

Example

import instana_client
from instana_client.models.session_replay_timestamps import SessionReplayTimestamps
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.MobileAppSessionReplayApi(api_client)
    mobile_app_id = 'app-456' # str | Mobile app identifier
    session_id = 'session-123' # str | Session identifier

    try:
        # Get session replay timestamps
        api_response = api_instance.get_session_replay_timestamps(mobile_app_id, session_id)
        print("The response of MobileAppSessionReplayApi->get_session_replay_timestamps:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MobileAppSessionReplayApi->get_session_replay_timestamps: %s\n" % e)

Parameters

Name Type Description Notes
mobile_app_id str Mobile app identifier
session_id str Session identifier

Return type

SessionReplayTimestamps

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request - Invalid mobile app ID or session ID -
401 Unauthorized access - requires user authentication. -
403 Forbidden - User doesn't have access to this mobile app -
404 Not Found - Mobile app or session not found -
500 Internal server error. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]