AppPush
WebPush
WhatsApp
Email
SMS
OTP
Marketing Automation
Attribute
Attributes are detailed descriptive data of user behavior, including three types: event attributes, user attributes, and device attributes. By further describing events/users/devices through attributes, they can be selected as filtering conditions in the user journey.
Attribute Types
Attributes are divided into three categories: event attributes, user attributes, and device attributes. Each category is further divided into standard, recommended, and custom attributes.
| Category | Attribute Type | Description |
|---|---|---|
| Event Attributes | Standard | Predefined event attributes automatically collected and reported by the SDK or generated through backend calculations |
| Recommended | Predefined event attributes reported by developers via API calls | |
| Custom | Event attributes freely created and reported by developers based on business needs | |
| Device Attributes | Standard | Predefined device information automatically collected and reported by the SDK or generated through backend calculations |
| User Attributes | Standard | Predefined user information automatically collected and reported by the SDK or generated through backend calculations |
| Recommended | Predefined event attributes reported by developers via API calls | |
| Custom | User attributes freely created and reported by developers based on business needs |
Attribute Data Types
| Data Type | Description |
|---|---|
| STRING | String type, such as "User Name," is generally set as STRING type |
| NUMBER | Numeric type, supporting integers and decimals, such as "Purchase Count," is generally set as NUMBER type |
| BOOL | Boolean type, supporting true/false, such as "Is VIP Member," is generally set as BOOL type |
| DATETIME | Date and time type, supporting data reported in ISO8601 format. For example, "Account Registration Time" is generally set as DATETIME type |
| LIST | List type, which is an array of string elements (e.g., ["Tesla", "Volkswagen", "Audi"]), such as "Interest Tags," is generally set as LIST type |
Custom Attributes
In addition to predefined standard and recommended attributes, developers can create custom "event attributes/user attributes" based on business needs. Custom attributes support two creation methods: page creation and API creation.
Page Creation
Attributes can be pre-created on the page, either individually or in bulk via Excel import. The required information includes:
| Information | Required | Description |
|---|---|---|
| Attribute Name | Required | The name of the reported attribute, supporting lowercase letters, numbers, and underscores, and must start with a letter, e.g., open_app. Once set, it cannot be changed. |
| Attribute Description | Required | Add a note to make your attribute easier to understand, up to 50 characters. Modifications are allowed after setting. |
| Data Type | Required | The data type determines how the MA system processes the attribute data. If the reported data does not match the type, it will be forcibly converted. If the conversion fails, the data will be discarded. Supported types include STRING, NUMBER, BOOL, DATETIME, and LIST. |
API Creation
Attributes can be freely reported via API calls. If the attribute does not exist, it will be automatically created:
- If the event attribute does not exist, it will be automatically created and associated with the event.
- If the user attribute does not exist, it will be automatically created.
Event reporting API interfaces: Android API, iOS API, Web API, Rest API
User attribute reporting API interfaces: Android API, iOS API, Web API, Rest API
Attribute Status
After custom event/user attributes are created, their initial status is visible. You can adjust their status based on business needs.
| Status | Description |
|---|---|
| Visible | Displayed in the attribute filter and can receive attribute reports |
| Hidden | Not displayed in the attribute filter but can receive attribute reports |
| Disabled | Not displayed in the attribute filter and cannot receive attribute reports |
Standard Attributes
EngageLab has predefined the names and descriptions of "event attributes, user attributes, and device attributes." The data is automatically collected and reported by the SDK or generated through backend calculations.
Standard attributes cannot be edited or deleted. The standard attribute list can be viewed on the page or downloaded as an Excel file for reference.
Recommended Attributes
EngageLab has predefined "event attributes and user attributes," and the data is reported by developers via API calls.
We recommend reporting recommended attributes as much as possible to facilitate subsequent analysis.
Recommended attributes cannot be edited or deleted. The recommended attribute list can be viewed on the page or downloaded as an Excel file for reference.
