Filter Definitions
Filters allow you to query and segment your data in the Embrace dashboard. Use filters to narrow down sessions, crashes, and other telemetry data based on specific criteria.
Understanding Filter Table Columns
Each filter table in this page uses the same columns:
- Filter - Human-readable name of the filter, with the key used in APIs or programmatic queries shown below it in monospace (for example,
app_version). - Description - Plain-language explanation of what the filter represents and how it is typically used.
- Type - Describes the data shape, such as String, Choice (String), int, float, Boolean, Date/DateTime, property (key-value pair), or intrange (integer range).
- Constraints - Describes any documented limits on valid values for the filter, such as enumerated choices. If no constraints are listed, the filter accepts any value that matches its type.
ANR Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Completioncompletion | State of the ANR at the time of session exit. | Choice (String) | Choices: all, completed, exit |
Duration Bucket (Milliseconds)duration | Duration of the ANR, bucketed by milliseconds. | intrange | — |
Methodmethod | Grouped method for the ANR. | String | — |
Sample Typesample_type | Type of sample (e.g., first, best). | Choice (String) | Choices: first, best, ad |
App Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
App Versionapp_version | Semantic version number of the app. | String | — |
Buildbuild | Build identifier of the app. | String | — |
Environmentenvironment | Deployment environment of the app. | String | — |
Environment Detailenvironment_detail | Detailed environment information. | String | — |
Last Viewlast_view | Last view screen visited in the session. | String | — |
SDK Versionsdk_version | Embrace SDK semantic version. | String | — |
Browser Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Botbot | Whether the session was generated by a bot. | Boolean | — |
Browser Major Versionbrowser_major_version | Major version of the web browser. | int | — |
Browser Namebrowser_name | Name of the web browser. | String | — |
Browser Versionbrowser_version | Full version of the web browser. | String | — |
Child Span Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Child Span Attribute Keychild_attribute_key | Key of a child span attribute. | String | — |
Child Span Duration (Milliseconds)child_duration | Duration of the child span in milliseconds. | int | — |
Child Span Event Namechild_event_name | Name of the event associated with the child span. | String | — |
Child Span Namechild_name | Name of the child span. | String | — |
Child Span Outcomechild_outcome | Outcome of the child span. | Choice (String) | Choices: successful, failure, user_abandon, unknown |
Child Span Attribute Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Child Span Attribute Key/Valuechild_attribute | Key/Value pair of a child span attribute. | property | — |
Crash Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Crash IDcrash_group_id | Unique identifier for the crash. | String | — |
File Namefile | File name associated with the event. | String | — |
Frameworkframework | Framework used by the app (e.g., Native, React Native, Flutter). | Choice (String) | Choices: native, react_native, unity |
Messagemsg | Message describing the crash. | String | — |
Symbolsymbol | Symbol associated with the crash. | String | — |
Tag Nametag_name | Name of the tag. | String | — |
Tag Name/Valuetag | Key/Value pair of the tag. | property | — |
Device Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Country ISOcountry | Device's country as a two letter ISO country code. | String | — |
Device Typedevice_type | Type of device (e.g., mobile, tablet). | Choice (String) | Choices: desktop, mobile, tablet |
Device Typemodel_type | Type/Category of the device model. | String | — |
Jailbrokenjailbroken | Whether or not the device running an app is jailbroken. | Boolean | — |
Js Patchjs_patch | JavaScript patch version. | String | — |
Manufacturermanufacturer | Name of the device hardware manufacturer. | String | — |
Model Factory Namemodel | Device hardware model identifier. | String | — |
Model Namemodel_market_name | Market name of the device model. | String | — |
Regionregion | Geographic region within a country, such as a state or province. | String | — |
Exception Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Group IDgroup_id | Group identifier for the exception. | String | — |
Is Handledis_handled | Whether the exception was handled by the app. | Boolean | — |
Severity Scoreseverity_score | Severity score of the exception. | float | — |
Log Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Aggregated Messagelog_msg | An aggregated form of the log message, with common patterns or high cardinality parts replaced. | String | — |
File Attachment Errorattachment_error | Error encountered when attempting to attach a file. | Choice (String) | Choices: ATTACHMENT_TOO_LARGE, OVER_MAX_ATTACHMENTS, UNKNOWN |
Group IDlog_group_id | Group identifier for the log. | String | — |
Has File Attachmenthas_attachment | Whether the log has a file attachment. | Boolean | — |
Has Logshas_log | Whether the session contains logs. | Choice (String) | Choices: true |
Log Property Keylog_property_key | Key of a log property. | String | — |
Messagelog_raw_msg | Message content of the log. | String | — |
Messageraw_msg | Message content of the log. | String | — |
Typelog_type | Type of the log or event. | Choice (String) | Choices: info, warning, error, system |
Typetype | Type of the log or event. | Choice (String) | Choices: info, warning, error, system |
Log Property Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Log Property Key/Valuelog_property | Key/Value pair of a log property. | property | — |
Network Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Connection Errorconnection_error | Type of connection error encountered. | Boolean | — |
Domaindomain | Domain of the HTTP network request. | String | — |
Duration Bucket (Milliseconds)duration_bucket | Bucket for network request duration. | int | — |
First Partyis_first_party | Whether the network request was to a first-party domain. | Boolean | — |
Has Connection Errorhas_connection_error | Whether the network request contains a network connection error. | Boolean | — |
Pathpath | Path element of the URL for an HTTP network request. | String | — |
Status Code Rangestatus_code | Filter by a range of HTTP response status codes. | intrange | — |
Status Code Singlestatus_code_single | Filter by a specific HTTP response status code. | int | — |
OS Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
OS Major Versionos_major_version | The major version of the OS. | int | — |
OS Nameos_name | Device operating system name. | String | — |
OS Versionos_version | Full operation system version. | String | — |
Root Span Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Root Span Duration (Milliseconds)root_span_duration | Duration of the root span in milliseconds. | int | — |
Root Span Duration Bucket (Milliseconds)root_span_duration_bucket | Bucket for root span duration. | int | — |
Root Span Event Nameroot_span_event_name | Event name associated with the root span. | String | — |
Root Span Nameroot_span_name | Name of the root span in a performance trace. | String | — |
Root Span Outcomeroot_span_outcome | Outcome of the root span. | Choice (String) | Choices: successful, failure, user_abandon, unknown |
Slow Root Spanroot_span_type_slow | Whether the root span is considered slow. | Boolean | — |
Root Span Attribute Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Root Span Attribute Key/Valueroot_span_attribute | Key/Value pair of a root span attribute. | property | — |
Session Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Active Interval Countactive_interval_count | Number of active intervals in the session. | int | — |
Breadcrumb Messagebreadcrumb_message | Message content of a breadcrumb. | String | — |
Has ANR Exithas_anr | True if the app exited while an ANR was occurring. | Boolean | — |
Has ANR Exithas_anr_exit | True if the app exited while an ANR was occurring. | Boolean | — |
Has Cold Startis_cold | True if this session is a cold start of the app. | Boolean | — |
Has Crashhas_crash | True if the session had a crash. | Boolean | — |
Has Low Memory Warninghas_low_memory | Whether the session had a low memory warning. | Boolean | — |
Has OOMhas_oom | True if the session had an out-of-memory event. | Boolean | — |
Inactive Interval Countinactive_interval_count | Number of inactive intervals in the session. | int | — |
Is Firstis_first | True if this is the user's first session. | Boolean | — |
Network Connectivitynetwork_connectivity | Type of network connection the device is using. | Choice (String) | Choices: mixed, none, wan, wifi |
Statestate | Whether the app was in the foreground or background. | Choice (String) | Choices: foreground, background |
Was User Terminatedhas_user_terminated | Whether the session was terminated by the user. | Boolean | — |
Span Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Has Slow Root Spanspan_type_slow | Whether the span is considered slow. | Boolean | — |
Span Attribute Keyspan_attribute_key | Key of a span attribute. | String | — |
Span Duration (Milliseconds)span_duration | Duration of the span in milliseconds. | int | — |
Span Duration Bucket (Milliseconds)span_duration_bucket | Bucket for span duration. | int | — |
Span Event Namespan_event_name | Event name associated with the span. | String | — |
Span Is Childis_child_span | Whether the span is a child span. | Boolean | — |
Span Namespan_name | Name of the span. | String | — |
Span Outcomespan_outcome | Outcome of the span. | Choice (String) | Choices: successful, failure, user_abandon, unknown |
Span Attribute Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Span Attribute Key/Valuespan_attribute | Key/Value pair of a span attribute. | property | — |
Surface Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Surface Namesurface_name | Name of the surface. | String | — |
User Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Embrace IDdevice_id | Unique identifier for the device (Embrace ID). | String | — |
Personapersona | User persona segment. | String | — |
User Emailuser_email | App user's email address. | String | — |
User IDuser_id | User identifier. | String | — |
Usernameuser_name | App user's username. | String | — |
User Flow Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
User Flow Duration (Milliseconds)user_flow_duration | Duration of the user flow in milliseconds. | int | — |
User Flow End Event Typeuser_flow_end_event_type | Type of event that ended the user flow. | Choice (String) | Choices: breadcrumb, crash, custom_view, log, network, session, span, user_tap, view, web_view |
User Flow End Reasonuser_flow_outcome_reason | Reason for the user flow outcome. | Choice (String) | Choices: app_exit, timeout, new_user_flow_started, crash |
User Flow Has Issueuser_flow_has_issue | Whether the user flow has an issue. | Choice (String) | Choices: anr, crash, error_log, network_error |
User Flow Nameuser_flow_name | Name of the user flow. | String | — |
User Flow Namecrash_user_flow_name | Name of the user flow. | String | — |
User Flow Outcomeuser_flow_outcome | Outcome of the user flow. | Choice (String) | Choices: abandon, complete, error |
User Flow Start Event Typeuser_flow_start_event_type | Type of event that started the user flow. | Choice (String) | Choices: breadcrumb, custom_view, log, network, session, span, user_tap, view, web_view |
User Flow Attribute Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
User Flow Attribute Key/Valueuser_flow_attribute | Key/Value pair of a user flow attribute. | property | — |
Web Resource Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Render Blocking Statusrender_blocking_status | Render blocking status of the resource. | Choice (String) | Choices: blocking, non-blocking |
Resource Typeresource_type | Type of web resource. | Choice (String) | Choices: script, stylesheet, image, font, video, audio, document, other |
Web Vital Filters
| Filter | Description | Type | Constraints |
|---|---|---|---|
Web Vital Namename | Name of the web vital. | String | — |
Web Vital Ratingrating | Rating of the web vital (e.g., good, poor). | Choice (String) | Choices: poor, needs_improvement, good |
Common Filter Combinations
Here are some examples of commonly used filter combinations:
Debug a Specific Version
- App Version equals
2.1.0 - Combine with other filters to narrow down issues
Find Users in a Specific Country
- Country ISO equals
US(or any two-letter country code) - Use with App Version to see regional adoption
Analyze Latest Version Performance
- App Version Set equals
latest - Compare metrics against previous versions