Fetch an app's sessions

GET/apps/{id}/sessions

Fetch an app's sessions by applying various optional filters.

For multiple comma separated fields, make sure no whitespace characters exist before or after commas. Pass limit and offset values to paginate results. When free_text is set, each result's matched_free_text field contains a space-separated string of match labels, e.g. "CrashType: NullPointerException CrashMessage: something went wrong".

In the response, meta.next / meta.previous are booleans indicating whether more pages exist in the respective direction. events is always null in list responses; it is populated only on the single-session detail endpoint. duration is the session duration in milliseconds.

Sessions that contain only a session start event, with no other activity, are always excluded from results regardless of filters.

Authorization

bearerAuth

AuthorizationBearer <token>

User access token issued at sign-in. Sent as Authorization: Bearer <access-token> unless cookies are used to send tokens. The /auth/refresh and /auth/signout endpoints expect the session's refresh token in the same header format instead.

In: header

Path Parameters

id*string

App's UUID.

Formatuuid

Query Parameters

from?string

ISO8601 timestamp to include sessions after this time.

to?string

ISO8601 timestamp to include sessions before this time.

versions?string

List of comma separated app version identifier strings to return only matching sessions.

version_codes?string

List of comma separated app version codes to return only matching sessions.

type?string

Comma-separated list of event source types to filter sessions. Accepted values: any combination of error, anr. error matches sessions with at least one exception event (fatal, unhandled, or handled); anr matches sessions with at least one ANR. When both type and severity are absent, all sessions are returned. When type is absent but severity is set, behaves as type=error,anr.

severity?string

Comma-separated list of exception severities to further narrow results. Accepted values: any combination of fatal, unhandled, handled. Severity filters only exceptions; ANR sessions are never filtered by severity.

bug_report?string

Boolean true/false to control if only sessions containing at least 1 bug report should be fetched.

background?string

Boolean true/false to control if only background sessions should be fetched.

foreground?string

Boolean true/false to control if only foreground sessions should be fetched.

user_interaction?string

Boolean true/false to control if only sessions that contain user interactions should be fetched.

countries?string

List of comma separated country identifier strings to return only matching sessions.

device_names?string

List of comma separated device name identifier strings to return only matching sessions.

device_manufacturers?string

List of comma separated device manufacturer identifier strings to return only matching sessions.

locales?string

List of comma separated device locale identifier strings to return only matching sessions.

network_providers?string

List of comma separated network provider identifier strings to return only matching sessions.

network_types?string

List of comma separated network type identifier strings to return only matching sessions.

network_generations?string

List of comma separated network generation identifier strings to return only matching sessions.

free_text?string

A keyword to search across session data. Matched against user ID, session ID, event types, custom type names, log strings, view and subview classnames, exception details (type, message, file, class, method) for fatal, unhandled, and handled exceptions, error codes, ANR details, and gesture target names.

offset?integer

Number of items to skip when paginating. Use with limit parameter to control amount of items fetched.

limit?integer

Number of items to return. Used for pagination. Should be used along with offset.

filter_short_code?string

Code representing combination of filters.

ud_expression?string

JSON string expression to filter using user defined attributes.

Response Body

`application/json`

curl -X GET "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/sessions"

{  "meta": {    "next": true,    "previous": false  },  "results": [    {      "session_id": "295842e1-7cd9-4ca3-8545-d6a5b36be9a4",      "app_id": "36e1b948-3a0a-4e71-80f3-625e61d6c832",      "attribute": {        "installation_id": "00000000-0000-0000-0000-000000000000",        "app_version": "0.8.0-SNAPSHOT.debug",        "app_build": "800",        "device_name": "emu64a16k",        "device_model": "sdk_gphone16k_arm64",        "device_manufacturer": "Google",        "os_name": "android",        "os_version": "35"      },      "events": null,      "first_event_time": "2024-10-26T05:52:43.104Z",      "last_event_time": "2024-10-26T05:53:58.596Z",      "duration": 75492,      "matched_free_text": "CrashType: NullPointerException CrashMessage: something went wrong"    },    {      "session_id": "2cc9ffd2-9f9d-40a7-9f55-d802a460507a",      "app_id": "36e1b948-3a0a-4e71-80f3-625e61d6c832",      "attribute": {        "installation_id": "00000000-0000-0000-0000-000000000000",        "app_version": "0.8.0-SNAPSHOT.debug",        "app_build": "800",        "device_name": "emu64a",        "device_model": "sdk_gphone64_arm64",        "device_manufacturer": "Google",        "os_name": "android",        "os_version": "33"      },      "events": null,      "first_event_time": "2024-10-02T18:26:58.226Z",      "last_event_time": "2024-10-02T18:27:09.151Z",      "duration": 10925,      "matched_free_text": ""    }  ]}

Empty