Preset attribute table
|
Collect
Note
Due to limitations of the iOS system, starting from iOS 16.4, the iOS SDK cannot collect carrier information. This means that for iOS 16.4 and above, all events tracked by the iOS SDK will not have the preset attribute $carrier.
Reference: iOS & iPadOS 16.4 Release Notes
| Category | English Variable Name | Display Name | Data Type | Detailed Explanation | Auto Tracking | Supports Disabling | Default Display | Privacy Risk Related | Data Source |
|---|---|---|---|---|---|---|---|---|---|
| Reserved Attribute | distinct_id | User ID | STRING | An anonymous ID before login, usually the device ID User ID after login More details refer to the user identifier | Yes | No | / | High |
|
| time | Time | DATETIME | The time when the event was triggered (accuracy: milliseconds) | Yes | No | / | None |
| |
| Basic Predefined Properties | $app_state | App State | STRING | The current state of the app This property is only available for $AppStartPassively | Yes | No | Yes | None |
|
| $app_id | Application unique identifier | STRING | The identifier of the app This property is available for Android, iOS, and Mini Program | Yes | No | Yes | None |
| |
| $app_name | Application Name | STRING | Application Name | Yes | No | Yes | None |
| |
| $app_version | Application Version | STRING | App Version | Yes | No | Yes | Low |
| |
| $is_first_day | Whether it is the first day of visit | BOOL | Whether the event is triggered on the first day, server-side correction More details refer to New users and first day first-time tag | Yes | No | Yes | Low |
| |
| $is_first_time | Whether it is the first time to trigger the event | BOOL | Whether the current user triggers this event for the first time, the server performs secondary corrections For more information, please refer toNew user and first day first-time mark | Yes | No | Yes | Low |
| |
| $timezone_offset | Timezone Offset | NUMBER | The number of minutes of the timezone offset of the device * -1 | Yes | No | Yes | Low |
| |
| $event_duration | Event Duration | NUMBER | Duration of the event (in seconds) | Yes | Yes | Yes | Low |
| |
| $latitude | Latitude | NUMBER | Dimension, iOS and Android need to be manually enabled | 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: The value of the android:label attribute of the Activity iOS: The title or text information on the titleView of the ViewController | Yes | Yes | Yes | Low |
| |
| $screen_name | Page Name | STRING | Android: Package name and class name of the Activity or Fragment iOS: Class name of the ViewController | Yes | Yes | Yes | Low |
| |
| app_crashed_reason | Crash Reason | STRING | Call stack information when the app crashes | No | Yes | Yes | None |
| |
| $url | Page URL | STRING | Android (v3.2.8+ Support), iOS (v1.11.5 ): Same as $screen_name Web JS: windows.location.href | No | No | is | low |
| |
| $url_query | Page Parameters | STRING | Contents after "?" in H5 page URL | Yes | Yes | Yes | low |
| |
| $url_path | Page Path | STRING | Contents between "/" and "?" in H5 page URL | Yes | is | is | low |
| |
| $referrer | Forward URL | STRING | Information of the previous page's $url For WeChat Mini Program, it is the $url_path of the previous page | is | is | is | medium |
| |
| $referrer_host | Forward Domain | STRING | $referrer host section | yes | yes | yes | within |
| |
| $referrer_title | previous page title | STRING | previous page title of the previous page | no | yes | yes | none |
| |
| $user_agent | UserAgent | STRING | UserAgent obtained through server-side parsing | No | Yes | No | Medium | / | |
| $scene | Launch scene | STRING | Scene information when opening the Mini Program | Yes | Yes | Yes | Low |
| |
| $share_depth | Number of shares | NUMBER | The level of the current user in the share chain For example, the original visitor is 0, and the visitor who opens the page through the original visitor's share is 1 | Yes | is | is | in |
| |
| $share_distinct_id | sharer | STRING | The user ID of the current mini program sharer | is | is | is | inside |
| |
| $share_url_path | share path | STRING | The path information when the mini program is shared | is | is | is | Low |
| |
| $share_method | Share Method | STRING | The method of sharing the Mini Program, such as sharing on WeChat Moments and forwarding message cards. | Yes | Yes | Yes | Low |
| |
| $source_package_name | Source Application Package Name | STRING | Package name of the source application | Yes | Yes | Yes | Medium | ||
| $bot_name | Spider Name | STRING | When the SDK identifies the access as a spider, it will attempt to parse this value. | Yes | Yes | Yes | Low |
| |
| $viewport_height | Viewport Height | NUMBER | The actual height of the browser's viewport (in pixels). | No | Yes | Yes | Low |
| |
| $viewport_position | Viewport Position from 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 viewport width of the browser (in px) | No | Yes | Yes | Low |
| |
| $item_join | Item Match Mode | - | User Dimension Table Name | No | Yes | Yes | None | ||
| $receive_time | $receive_time | NUMBER | Time when the server received the event | Yes | No | No | None |
| |
| $lib_plugin_version | SDK Plugin Version | LIST | Sensors Analytics Plugin Versions | 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 | is | in |
| |
| $os | Operating System | STRING | Operating System | Yes | No | Yes | in |
| |
| $os_version | Operating System Version | STRING | Operating System Version | Yes | No | Yes | 中 |
| |
| $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 | Whether WIFI | BOOL | Whether WIFI network | Yes | No | is | low |
| |
| $carrier | carrier | STRING | device carrier information | yes | no | yes | medium |
| |
| $network_type | network type | STRING | network type | yes | no | is | low |
| |
| $device_id | Device ID | STRING | Android: AndroidID iOS: IDFA or IDFV | No | No | Yes | high |
| |
| $screen_orientation | Screen Orientation | STRING | Current orientation of the device (landscape or portrait) | No | Yes | Yes | Low |
| |
| Browser-related | $browser | Browser | STRING | Browser | Yes | No | Yes | Medium |
|
| $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 | is | is | is | low |
| |
| $element_type | Element Type | STRING | Control type | is | is | is | low |
| |
| $element_content | Element Content | STRING | Element Content | Yes | Yes | Yes | Low |
| |
| $element_position | Element Position | STRING | The position of the clicked element within the list control | Yes | Yes | Yes | Low |
| |
| $element_selector | Element Selector | STRING | Element Path Information Used for matching in App Heatmap Analysis | No | Yes | Yes | Low |
| |
| $element_target_url | Element Link Address | STRING | Element Link Address | Yes | Yes | Yes | low |
| |
| $element_class_name | element class name | STRING | element class name | Yes | Yes | Yes | low |
| |
| latest related attributes | $latest_referrer | latest external referrer | STRING | latest external referrer | Yes | Yes | Yes | In |
|
| $latest_referrer_host | Latest Referrer Host | STRING | Latest Referrer Host | No | Yes | Yes | Metric |
| |
| $latest_search_keyword | Latest Search Engine Keyword | STRING | Search keyword parsed from $latest_referrer | Yes | Yes | Yes | Metric |
| |
| $latest_traffic_source_type | Latest Traffic Source Type | STRING | Latest Traffic Source Type | Yes | Yes | Yes | In |
| |
| $latest_landing_page | Latest Landing Page | STRING | Latest Landing Page | No | Yes | Yes | In |
| |
| $latest_utm_campaign | Recent Ad Campaign Name | STRING | Recent Ad Campaign Name | Yes | Yes | Yes | In |
| |
| $latest_utm_content | Recent Ad Campaign Content | STRING | Recent Ad Campaign Content | Yes | Yes | Yes | In |
| |
| $latest_utm_medium | Recent Ad Campaign Medium | STRING | Last Ad Campaign Medium | Yes | Yes | Yes | In |
| |
| $latest_utm_source | Last Ad Campaign Source | STRING | Last Ad Campaign Source | Yes | Yes | Yes | In |
| |
| $latest_utm_term | Last Ad Campaign Keyword | STRING | Last Ad Campaign Keyword | Yes | Yes | Yes | In |
| |
| $latest_scene | Last launched scene | STRING | Last launched scene | Yes | Yes | Yes | Low |
| |
| $latest_share_method | The way of the last share | STRING | The way of the last share | 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 | Tracking method | STRING | Triggering method for tracking (full tracking, custom tracking) Unified custom tracking for web and mini-program SDK | Yes | No | No | None |
| |
| $lib_detail | User Behavior Details | STRING | Call stack information when triggering the user behavior | Yes | Yes | No | None |
| |
| Channel Related | $ios_install_source | Device fingerprint information required for app channel matching | STRING | For Android: IMEI information For iOS: IDFA information Do not store as attribute Attribute is deleted after server-side channel matching | No | Yes | / | High |
|
| $channel_device_info | Device fingerprint information required for app channel matching (different from the event variable name above) | STRING | Attribute not stored in Database The attribute is deleted after server-side channel matching | No | Yes | / | High |
| |
| $ios_install_disable_callback | Whether to disable tracking callback | BOOL | Whether to disable tracking callback | No | Yes | Yes | low |
| |
| $is_channel_callback_event | Whether to perform channel matching callback | BOOL | Whether the channel matching result of the event needs to be callback to the channel provider | No | Yes | No | low |
| |
| $channel_extra_information | Channel extra information | STRING | Additional information added to the channel tracking link Such as IMEI, OAID | No | Yes | No | High | / | |
| $utm_matching_type | Channel Tracking Matching Type | STRING | Fuzzy Matching, Exact Matching | No | Yes | Yes | Low |
| |
| $utm_source | Advertising Campaign Source | STRING | Advertising Campaign Source | No | Yes | is | in |
| |
| $utm_medium | Advertising Campaign Medium | STRING | Advertising Campaign Medium | No | Yes | Yes | in |
| |
| $utm_term | Advertising Campaign Term | STRING | Ad Campaign Keyword | No | Yes | Yes | In |
| |
| $utm_content | Ad Campaign Content | STRING | Ad Campaign Content | No | Yes | Yes | In |
| |
| $utm_campaign | Ad Campaign Name | STRING | Ad Campaign Name | No | Yes | Yes | Medium |
| |
| $matched_key | Channel Matching Keyword | STRING | This attribute is not available by default when collecting events in the App, but is added in the extractor module. It is used to record the matching key field when the App channel tracking is successful. For example, if it is matched successfully using IMEI, then the MD5 of the IMEI will be recorded. If it is matched successfully using IP_UA, then it will be recorded as IP_UA. If there is no successful match, the attribute value will be displayed as "Unknown" in the event analysis page. | No | Yes | Is | High |
| |
| $matching_key_list | Channel Matching Keyword List | STRING | Supported since SA 1.14 version; The default is not available when collecting events on the App side, instead it is added in the extractor module. It records all the matching keywords of the activation event, such as the MD5-encrypted IMEI, Android ID, OAID, IP_UA, etc. During the matching process, it matches with the priority of these keywords and the recorded keywords when clicking on ads. | No | Yes | No | High |
| |
| $short_url_key | Short URL Key | STRING | The last node value of the path in the short link URL | No | Yes | Yes | Low | / | |
| $short_url_target | Short link target address | STRING | Complete URL corresponding to the short link | No | Yes | Yes | Low | / | |
| $channel_active_period_day | Active Window Period (Days) | NUMBER | Records the information of the window period configuration, and traces the changes in activation caused by window period changes | Yes | No | Yes | None | / | |
| $channel_callback_period_day | Depth Return Attribution Window (days) | NUMBER | Yes | No | Yes | None | / | ||
| $channel_attribute_period_hour | Activation Attribution Window (hours) | NUMBER | Yes | No | Yes | None | / | ||
| $channel_name | Channel Name | STRING | Related to front-end advertising data, used for association and filtering when generating delivery analysis reports | Yes | No | Yes | None | / | |
| $channel_account_id | Channel Advertiser ID | STRING | Yes | No | Yes | None | / | ||
| $channel_campaign_id | Channel Ad Campaign ID | STRING | Yes | No | Yes | No | / | ||
| $channel_adgroup_id | Channel Ad Group ID | STRING | Yes | No | Yes | No | / | ||
| $channel_ad_id | Channel Ad Creative ID | STRING | Yes | No | Yes | No | / | ||
| $channel_click_id | Channel Click ID | STRING | Check click data with advertising platform | Yes | No | Yes | None | / | |
| $first_channel_name | First Channel Name | STRING | Associated with front-end advertising data, used for generating delivery analysis report | Yes | No | Yes | None | / | |
| $first_channel_account_id | First Channel Advertiser ID | STRING | Yes | No | No | None | / | ||
| $first_channel_campaign_id | First Channel Campaign ID | STRING | Yes | No | No | None | / | ||
| $first_channel_adgroup_id | First Channel Adgroup ID | STRING | Yes | No | No | None | / | ||
| $first_channel_ad_id | First Channel Ad ID | STRING | Yes | No | No | None | / | ||
| $first_channel_click_id | First Channel Click ID | STRING | Verify Click Data with Ad Platforms | Yes | No | Yes | None | / | |
| $channel_active_result | Channel Activation | BOOL | Yes | No | Yes | None | / | ||
| IP-related | $ip | IP | STRING | Nginx Parsing | Yes | No | Yes | None |
|
| $city | City | STRING | IP Resolution | Yes | No | Yes | None |
| |
| $province | Province | STRING | IP Resolution | Yes | No | Yes | None |
| |
| $country | Country | STRING | IP Resolve | Yes | No | Yes | None |
| |
| $ip_isp | IP ISP | STRING | IP Resolve | Yes | No | Yes | None |
| |
| User association related | $is_login_id | Is Login ID | BOOL | Whether the distinct_id of the event is a Login ID, added when the event is stored | Yes | No | No | Low |
|
| $track_signup_original_id | Associate Original ID | STRING | User login, used to associate with anonymous ID | Yes | No | Yes | High | / | |
| item-related preset properties | $is_valid | Is banned | BOOL | Whether the record is valid | Yes | No | Yes | Low | / |
| $receive_time | Arrival time | NUMBER | Yes | No | Yes | Low | / | ||
| $update_time | Update Time | DATETIME | Yes | No | Yes | Low | / |
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