Pre-set Attribute Overall Table
|
Collect
Note
Due to the restriction of iOS system, version 16.4 and above of iOS, the iOS SDK doesn't collect carrier information. That is, all events of iOS SDK doesn't have the preset attribute $carrier in iOS system version 16.4 and above.
Reference: iOS & iPadOS 16.4 Release Notes
1. Preset Event Attribute
| Category | Attribute Name | Attribute Display Name | Data Type | Detailed Explanation | Is Automatically Collected | Is Close Supportable | Is Default Display | Privacy Risk Related | Collection End |
|---|---|---|---|---|---|---|---|---|---|
| Reserved Attribute | distinct_id | User ID | STRING | Before logging in, it is an anonymous ID, usually the device ID After login is Login ID For more details, refer to Identify Users-Simple user association (IDM 2.0 & IDM 1.0) | Yes | No | / | High |
|
| time | Time | DATETIME | Event trigger time (precision: milliseconds) | Yes | No | / | None |
| |
| Basic Preset Attributes | $app_state | App status | STRING | Current status of the App Only $AppStartPassively has this attribute | Yes | No | Yes | None |
|
| $app_id | Unique Application Identifier | STRING | App Identifier Android, iOS, Mini Programs have this attribute | Yes | No | Yes | None |
| |
| $app_name | Application Name | STRING | Application Name | Yes | No | Yes | None |
| |
| $app_version | Application Version | STRING | App version number | Yes | No | Yes | Low |
| |
| $resume_from_background | Is it awakened from the background | BOOL | App is awakened from the background or not | Yes | No | Yes | None |
| |
| $is_first_day | Is it the first day of visit | BOOL | If the event triggered on the first day, the server will make a second correction For more details, refer to New Users and First Day First Time Marking | Yes | No | Yes | Low |
| |
| $is_first_time | Whether the event is triggered for the first time | BOOL | Whether this is the first time the current user trigger this event, the server will make a second correction For more information, please refer to New Users and First Day First Time Marking | Yes | No | Yes | Low |
| |
| $timezone_offset | Time Zone Offset | NUMBER | The offset of the time zone where the device is located in minutes * -1 | Yes | No | Yes | Low |
| |
| $event_duration | Event Duration | NUMBER | Duration of the event (in seconds) | Yes | Yes | Yes | Low |
| |
| $latitude | Latitude | NUMBER | Latitude, iOS and Android need to be enabled manually | No | Yes | Yes | High |
| |
| $longitude | Longitude | NUMBER | Longitude, iOS and Android need to be manually enabled | No | Yes | Yes | High |
| |
| $title | Page Title | STRING | Android: android:label attribute value of Activity iOS: text information on title or titleView of ViewController | Yes | Yes | Yes | Low |
| |
| $screen_name | Page Name | STRING | Android: Package name corresponding to Activity or Fragment.Class name iOS: Class name of ViewController | Yes | Yes | Yes | Low |
| |
| $app_crashed_reason | Crash Reason | STRING | Call stack information when the App crashes | No | Yes | Yes | No |
| |
| $url | Page URL | STRING | Android(v3.2.8+ Supports)、iOS( v1.11.5 ): similar to $screen_name Web JS：windows.location.href | No | No | Yes | Low |
| |
| $url_host | Domain Name of Page URL | STRING | Page Domain Address | Yes | No | Yes | Low |
| |
| $url_query | Page Parameter | STRING | Content after "?" in H5 page URL | Yes | Yes | Yes | Low |
| |
| $url_path | Page Path | STRING | Content between "/" and "?" in H5 page URL | Yes | Yes | Yes | Low |
| |
| $referrer | Forward Address | STRING | Information of previous page's $url WeChat Mini Program is for the previous page's $url_path | Yes | Yes | Yes | Medium |
| |
| $referrer_host | Forward Domain | STRING | The host part of $referrer | Yes | Yes | Yes | Medium |
| |
| $referrer_title | Forward page title | STRING | Title of the previous page | No | Yes | Yes | None |
| |
| $user_agent | UserAgent | STRING | UserAgent, obtained by server-side parsing | No | Yes | No | Medium | / | |
| $scene | Startup scene | STRING | Scene information when opening the applet | Yes | Yes | Yes | Low |
| |
| $share_depth | Shares count | NUMBER | Level of the current user in the share chain E.g. The original visitor is 0, visitors who open the page via the original visitor's share is 1 | Yes | Yes | Yes | Medium |
| |
| $share_distinct_id | Sharer | STRING | Current Mini-program sharer's user ID | Yes | Yes | Yes | Medium |
| |
| $share_url_path | Shared Path | STRING | Path information when the mini-program is shared | Yes | Yes | Yes | Low |
| |
| $share_method | Sharing approach | STRING | Approach of sharing mini program, such as share in Moments, forward message card, etc. | Yes | Yes | Yes | Low |
| |
| $source_package_name | Source App Package Name | STRING | Name of the source app package | Yes | Yes | Yes | Medium | ||
| $bot_name | Crawler Name | STRING | Only when the SDK judges as a crawler visit, it will try to parse this value | Yes | Yes | Yes | Low |
| |
| $viewport_height | Viewport Height | NUMBER | The actual browser viewport height (unit: px) | No | Yes | Yes | Low |
| |
| $viewport_position | Position of the viewport from the top | NUMBER | Unit: px If there is no scroll bar on the page, this attribute is 0 | No | Yes | Yes | Low |
| |
| $viewport_width | Viewport width | NUMBER | Actual browser viewport width (Unit: px) | No | Yes | Yes | Low |
| |
| $item_join | Item Matching Mode | - | Corresponding dimension table name | No | Yes | Yes | None | ||
| $receive_time | $receive_time | NUMBER | The time when the server received this event | Yes | No | No | None |
| |
| $lib_plugin_version | SDK Plugin Version | LIST | Versions of various plugins for Sensors Analytics | Yes | No | No | None |
| |
| Device Related | $brand | Device Brand | STRING | Device Brand | Yes | No | Yes | Medium |
|
| $manufacturer | Device Manufacturer | STRING | Device Manufacturer | Yes | No | Yes | Medium |
| |
| $model | Device Model | STRING | Device Model | Yes | No | Yes | Medium |
| |
| $os | Operating System | STRING | Operating System | Yes | No | Yes | Medium |
| |
| $os_version | Operating System Version | STRING | Operating System Version Number | Yes | No | Yes | Medium |
| |
| $screen_height | Screen Height | NUMBER | Mobile Screen Height | Yes | No | Yes | Low |
| |
| $screen_width | Screen Width | NUMBER | Mobile Screen Width | Yes | No | Yes | Low |
| |
| $wifi | WIFI or not | BOOL | WIFI network or not | Yes | No | Yes | Low |
| |
| $carrier | Carrier | STRING | Device carrier information | Yes | No | Yes | Medium |
| |
| $network_type | Network Type | STRING | Network Type | Yes | No | Yes | low |
| |
| $device_id | Device ID | STRING | Android: AndroidID iOS: IDFA or IDFV | No | No | Yes | high |
| |
| $screen_orientation | Screen Orientation | STRING | Current device orientation (horizontal or vertical) | No | Yes | Yes | Low |
| |
| Browser related | $browser | Browser | STRING | Browser | Yes | No | Yes | Medium |
|
| $browser_language | User browser language | STRING | User Browser Language | Yes | No | Yes | None |
| |
| $browser_version | Browser Version | STRING | Browser Version | Yes | No | Yes | Medium |
| |
| Click Event Related | $element_id | Element ID | STRING | Android: Widget android:id | Yes | Yes | Yes | Low |
|
| $element_name | Element name | STRING | Element name | Yes | Yes | Yes | Low |
| |
| $element_type | Element Type | STRING | Type of control | Yes | Yes | Yes | Low |
| |
| $element_content | Element Content | STRING | Element Content | Yes | Yes | Yes | Low |
| |
| $element_position | Element Position | STRING | The position of the clicked element in the list widget | Yes | Yes | Yes | Low |
| |
| $element_selector | Element Selector | STRING | Path information of the element App Clicks Analysis uses this property for matching | No | Yes | Yes | Low |
| |
| $element_path | Element Path | STRING | Element Path Information This attribute is used for matching in full visualization tracking | No | Yes | Yes | Low |
| |
| $element_target_url | Element Link Address | STRING | Element Link Address | Yes | Yes | Yes | Low |
| |
| $element_class_name | Element Style Name | STRING | Element Style Name | Yes | Yes | Yes | Low |
| |
| $page_x | Page X Coordinate | NUMBER | X coordinate value of the page when clicked | Yes | Yes | Yes | Low |
| |
| $page_y | Page Y Coordinate | NUMBER | Y coordinate value of the page at the time of click | Yes | Yes | Yes | Low |
| |
| latest related attributes | $latest_referrer | Latest external address | STRING | Latest external address | Yes | Yes | Yes | Medium |
|
| $latest_referrer_host | Last external domain | STRING | Last external domain | No | Yes | Yes | Medium |
| |
| $latest_search_keyword | Last search engine keyword | STRING | Search keywords parsed from the $latest_referrer | Yes | Yes | Yes | Medium |
| |
| $latest_traffic_source_type | Latest Traffic Source Type | STRING | Latest Traffic Source Type | Yes | Yes | Yes | Medium |
| |
| $latest_landing_page | Latest Landing Page | STRING | Latest Landing Page | No | Yes | Yes | Medium |
| |
| $latest_utm_campaign | Latest Advertisement Campaign Name | STRING | Last Ad Campaign Name | Yes | Yes | Yes | Medium |
| |
| $latest_utm_content | Last Ad Campaign Content | STRING | Last Ad Campaign Content | Yes | Yes | Yes | Medium |
| |
| $latest_utm_medium | Last Ad Campaign Medium | STRING | Last Ad Campaign Medium | Yes | Yes | Yes | Medium |
| |
| $latest_utm_source | The latest campaign source | STRING | The latest campaign source | Yes | Yes | Yes | Medium |
| |
| $latest_utm_term | The latest campaign term | STRING | The latest campaign term | Yes | Yes | Yes | Medium |
| |
| $latest_scene | Last Launch Scenario | STRING | Last Launch Scenario | Yes | Yes | Yes | Low |
| |
| $latest_share_method | Last Sharing Approach | STRING | Last Sharing Approach | Yes | Yes | Yes | Low |
| |
| $latest_share_distinct_id | The most recent sharer | STRING | The most recent sharer | Yes | Yes | Yes | Low |
| |
| $latest_share_depth | The latest share depth | NUMBER | The latest share depth | Yes | Yes | Yes | Low |
| |
| $latest_share_url_path | Last share path | STRING | Last share path | Yes | Yes | Yes | Low |
| |
| SDK related | $lib | SDK Type | STRING | SDK type, such as Android, iOS | Yes | No | Yes | None |
|
| $lib_version | SDK Version | STRING | SDK Version | Yes | No | No | None |
| |
| $lib_method | Burial Method | STRING | The trigger mode of burying point (full burying, custom burying) Web and Mini Program SDKs are unified as custom burying | Yes | No | No | None |
| |
| $lib_detail | Buried Point Detail | STRING | Call stack information when triggering buried point | Yes | Yes | No | None |
| |
| Channel Related | $ios_install_source | Device fingerprint information needed for App channel matching | STRING | Android: IMEI information iOS: IDFA information Attribute not stored Remove the attribute after Channel Matching on the server side | No | Yes | / | High |
|
| $channel_device_info | Device fingerprint information needed for App Channel Matching (Different from the Event variable name above) | STRING | Attribute not stored Remove the attribute after Channel Matching on the server side | No | Yes | / | High |
| |
| $ios_install_disable_callback | Whether to disable tracking callback or not | BOOL | Whether to disable tracking callback or not | No | Yes | Yes | Low |
| |
| $is_channel_callback_event | Whether to perform channel matching callback | BOOL | Whether the event channel match result needs to be callback to the channel provider | No | Yes | No | Low |
| |
| $channel_extra_information | Channel Extra Information | STRING | Additional information added in the channel monitoring link Such as IMEI, OAID | No | Yes | No | High | / | |
| $utm_matching_type | Channel Tracking Matching Mode | STRING | Fuzzy Matching, Accurate Match | No | Yes | Yes | Low |
| |
| $utm_source | Advertising Campaign Source | STRING | Advertising Campaign Source | No | Yes | Yes | Medium |
| |
| $utm_medium | Advertising Campaign Medium | STRING | Advertising Campaign Medium | No | Yes | Yes | Medium |
| |
| $utm_term | Advertising Campaign Keywords | STRING | Advertising Campaign Keywords | No | Yes | Yes | Medium |
| |
| $utm_content | Advertising Campaign Content | STRING | Advertising Campaign Content | No | Yes | Yes | Medium |
| |
| $utm_campaign | Ad Campaign Name | STRING | Ad Campaign Name | No | Yes | Yes | Medium |
| |
| $matched_key | Channel Match Keyword | STRING | This attribute is not necessarily present during event collection in the App end, but rather added in the extractor module. It records the matching keyword when App channel tracking is successful. For example, if the matching is successful with IMEI, it records the IMEI after md5. If the matching is successful with IP_UA, it records as IP_UA. If the matching is not successful， the attribute value is displayed as "unknown" on the event analysis page. | No | Yes | Yes | High |
| |
| $matching_key_list | Channel Match Keyword List | STRING | SA version 1.14 and later is supported; During the collection of events in the App side by default, this property does not exist but is added in the extractor module. It records all the potential matchable keywords of this activation event, such as IMEI after md5, Android ID, oaid, IP_UA, etc. The matching is performed based on the priority of these keywords and the keywords recorded when clicking on the advertisement. | No | Yes | No | High |
| |
| $short_url_key | Short Link Key | STRING | Last node value in the short link URL path | No | Yes | Yes | Low | / | |
| $short_url_target | Short link target address | STRING | Short link corresponding to the full URL | No | Yes | Yes | Low | / | |
| $channel_active_period_day | Effective Activation Window Period (Days) | NUMBER | Record the information of the window period configuration. The activation changes caused by the window period change can also be traced back. | Yes | No | Yes | None | / | |
| $channel_callback_period_day | Deep passback attribution window period (days) | NUMBER | Yes | No | Yes | None | / | ||
| $channel_attribute_period_hour | Activation attribution window period (hours) | NUMBER | Yes | No | Yes | No | / | ||
| $channel_name | Channel Name | STRING | Associated with frontend advertising data for generating and filtering delivery analysis reports | Yes | No | Yes | No | / | |
| $channel_account_id | Channel Advertiser ID | STRING | Yes | No | Yes | No | / | ||
| $channel_campaign_id | Channel Advertiser ID | STRING | Yes | No | Yes | No | / | ||
| $channel_adgroup_id | Channel Advertise Group ID | STRING | Yes | No | Yes | No | / | ||
| $channel_ad_id | Channel Advertising Creatives ID | STRING | Yes | No | Yes | None | / | ||
| $channel_click_id | Channel monitoring click ID | STRING | Check click data with advertising platform | Yes | No | Yes | None | / | |
| $channel_active_result | Channel activation valid identifier | BOOL | Yes | No | Yes | None | / | ||
| IP Related | $ip | IP | STRING | Nginx Parsing | Yes | No | Yes | None |
|
| $city | City | STRING | Based on IP Parsing | Yes | No | Yes | None |
| |
| $province | Province | STRING | Based on IP resolution | Yes | No | Yes | None |
| |
| $country | Country | STRING | Based on IP resolution | Yes | No | Yes | None |
| |
| $ip_isp | IP operator | STRING | Based on IP resolution | Yes | No | Yes | None |
| |
| User Association Related | $is_login_id | Whether login ID | BOOL | Whether the event's distinct_id is a login ID, added when the event is stored | Yes | No | No | Low |
|
| $track_signup_original_id | Associated Original ID | STRING | In the case of user login, the anonymous ID used for association | Yes | No | Yes | High | / | |
| Universal data access | $data_ingestion_source | Data Ingestion Source | LIST | Data Ingestion Source | Yes | No | Yes | None | / |
| $data_ingestion_job_id | Data Ingestion Task ID | STRING | Data Ingestion Task ID | Yes | No | Yes | None | / | |
| Item-related predefined attributes | item_id | Item ID | STRING | Item ID | Yes | No | Yes | Low | / |
| item_type | Item Type | STRING | Item Type | Yes | No | Yes | Low | / | |
| $create_time | Arrival Time | NUMBER | Create Time | Yes | No | Yes | Low | / | |
| $update_time | Update Time | NUMBER | Update Time | Yes | No | Yes | Low | / |
2. Pre-set user attributes
| Attribute Name | Attribute Display Name | Data Type |
|---|---|---|
| $city | City | STRING |
| $country | Country | STRING |
| $province | Province | STRING |
| $first_browser_charset | First browser character type | STRING |
| $first_browser_language | Browser language | STRING |
| $first_referrer | First forward address | STRING |
| $first_referrer_host | First forward domain | STRING |
| $first_search_keyword | First search engine keyword | STRING |
| $first_traffic_source_type | First traffic source type | STRING |
| $first_visit_time | First visit time | DATETIME |
| $utm_campaign | First Advertising Campaign Name | STRING |
| $utm_content | First Advertising Campaign Content | STRING |
| $utm_matching_type | Channel Track Matching Mode | STRING |
| $utm_medium | First ad campaign medium | STRING |
| $utm_source | First ad campaign source | STRING |
| $utm_term | First ad campaign term | STRING |
| $update_time | $update_time | NUMBER |
| $first_channel_name | First channel name | STRING |
| $first_channel_account_id | First channel advertiser ID | STRING |
| $first_channel_campaign_id | First Channel Advertising Plan ID | STRING |
| $first_channel_adgroup_id | First Channel Advertising Group ID | STRING |
| $first_channel_ad_id | First Channel Advertising Creative ID | STRING |
| $first_channel_click_id | First Channel Monitoring Click ID | STRING |
This document only includes general preset properties. For preset properties of modules such as Smart Operations, Channel Track, etc., please visit the corresponding document.
Note: The content of this document is a technical document that provides details on how to use the Sensors product and does not include sales terms; the specific content of enterprise procurement products and technical services shall be subject to the commercial procurement contract.
Popular Searches