User Schema Reference

The following schema lists the attributes we recommend collecting for user profiles. Collecting all recommended data ensures data completeness, ensuring you get the best results from Appier features.

Property types

There are two attribute types, and the type tells you who defines the attribute and where its value comes from.

Default: Appier collects these automatically through the SDK. You don't need to send them yourself. Examples: ip, permission, gcm_id.
System-defined: Appier defines the key and data type, and you provide the value. You can't change the key or data type, so send the data exactly as defined here for Appier features to recognize it. Examples: first_name, email, phone_no, line_uid.

Schema properties

Key

Display name

Data type

Description

Property type

account_linked

Account linked

string

The user's member ID in your CRM system. Only used by BotBonnie.

Example: "U1234acbd5678"

System-defined

appier_id

Appier ID

integer

The identifier that Appier assigns to the user.

Example: 1234567890123456789

Default

birthday

Birthday

string

The user's date of birth. The data type can be string or integer, depending on your setup.

Example: "1990-05-14"

System-defined

city

City

string

The user's city.

Example: "Taipei"

System-defined

ec_account_linked

EC account linked

string

The user's member ID on your e-commerce (EC) platform, like 91APP or SHOPLINE. Only used by BotBonnie.

Example: "Y123456"

System-defined

email

string

The user's email address, used for email sending.

Example: "[email protected]"

System-defined

first_name

First name

string

The user's first name.

Example: "Jane"

System-defined

gcm_id

GCM ID

string

The user's push notification token. The format depends on the platform:

Android and web: A Firebase Cloud Messaging (FCM) registration token, about 150 characters long.
iOS: An Apple Push Notification service (APNs) device token, 64 hexadecimal characters long.

Example: "dGCSgbfREPc:APA91bHiidOoq_iB3Vqbqq7OM2XAJKlLQSyYp954VEDMovG4-NxNnSujamBbReKwK_RSqf3OaDo8Ip54_uC9-N5fqXtyYmXQGEMQr3SDKGp27MPbe9D-oXxKz935wE1WM2srElISB--e"

Default

instagram_uid

Instagram UID

string

The user's Instagram channel ID. This is Meta's Instagram-scoped ID (IGSID), a numeric string assigned per business account.

System-defined

ip

string

The user's IP address.

Example: "203.0.113.10"

Default

is_incognito

Is incognito

boolean

Whether the user's browser is in incognito (private) mode.

Example: false

Default

kakao_uid

Kakao UID

string

The user's KakaoTalk channel ID.

System-defined

last_name

Last name

string

The user's last name.

Example: "Doe"

System-defined

line_uid

LINE UID

string

The LINE user ID of a user who follows your LINE channel.

System-defined

line_unfollow_time

LINE unfollow time

integer

The date the user was detected as no longer following your LINE channel. Detection runs once a day, so this date may be one day later than the actual unfollow date. To use this attribute in segments, contact Appier Support. The value is a Unix timestamp in seconds.

Example: 1727654400

Default

messenger_uid

Messenger UID

string

The user's Messenger channel ID. This is Facebook's page-scoped ID (PSID), a numeric string.

Example: "3067708500516264"

System-defined

permission

Permission

string

The user's web push subscription status: granted, denied, or default.

Example: "granted"

Default

phone_no

Phone number

string

The user's mobile phone number, used for SMS sending, in E.164 format.

Example: "+886912345678"

System-defined

reason

Reason

string

Set to badDeviceToken when the user's Apple Push Notification service (APNs) token is invalid.

Example: "badDeviceToken"

Default

user_agent

User agent

string

The user agent string of the user's browser.

Example: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) ..."

Default

user_id

user_id

string

The user's ID from your CRM system.

System-defined

viber_uid

Viber UID

string

The user's Viber channel ID.

System-defined

webchat_uid

Webchat UID

string

The user's web chat channel ID.

System-defined

whatsapp_uid

WhatsApp UID

string

The user's WhatsApp channel ID.

System-defined

zalo_uid

Zalo UID

string

The user's Zalo channel ID.

System-defined

AIRIS default properties

AIRIS collects the following default properties automatically. You don't need to send them yourself.

AIRIS user properties

These properties describe how AIRIS first saw the user.

Key

Display name

Data type

Description

Property type

~d

First Event Timestamp

Timestamp (Unix)

When the user's first event took place.

Default

~a

First Referrer Type

Referrer Type

The referrer type of the user's first visit: Direct, Search Engine, Social Networks, Email, Back Links, Internal, or PPC.

Default

~b

First Referrer URL

Text

The referrer URL of the user's first visit. It may not include the path and query, because HTTPS referrer data is limited for privacy.

Default

~f

First Landing Page

Text

The URL path of the user's first page view.

Default

~j

First Campaign Name

Text

The first specific product promotion or strategic campaign, from utm_campaign.

Default

~k

First Campaign Source

Text

The site that first sent the user's traffic, from utm_source.

Default

~m

First Campaign Medium

Text

The type of link the user first came from, such as cost per click or email, from utm_medium.

Default

~n

First Campaign Content

Text

What the user first clicked to reach the site, from utm_content.

Default

~l

First Campaign Term

Text

The user's first search terms, from utm_term.

Default

AIRIS visit properties

These properties describe a single visit.

Key

Display name

Data type

Description

Property type

city

City

Text

The visit's city, based on GeoIP.

Default

region

State/Region

Text

The visit's state or region, based on GeoIP.

Default

country

Country

The visit's country, based on GeoIP.

Default

continent

Continent

The visit's continent, based on GeoIP.

Default

timezone

Time Zone

Text

The visit's time zone.

Example: "America/Los_Angeles"

Default

offset

Time Zone Offset

Text

The visit's time zone offset.

Example: "+08:00"

Default

device

Device Type

The device type: Desktop, Tablet, or Mobile.

Default

ip

IP Address

Text

The visit's IP address.

Default

screen

Screen Resolution

Text

The device's screen resolution.

Example: "2560x1440"

Default

language

Language

Text

The language preference set in the device's operating system or web browser.

Default

os

Operating System

Text

The device's operating system.

Default

browser

Browser

Text

The web browser used for the visit.

Default

time

Visit Date/Time

Timestamp (Unix)

The date and time the visit began.

Default

time

Hour of Visit

Timestamp (Unix)

The hour the visit began.

Default

time

Day of Visit

Timestamp (Unix)

The day the visit began.

Default

time

Week of Visit

Timestamp (Unix)

The week the visit began.

Default

time

Month of Visit

Timestamp (Unix)

The month the visit began.

Default

time

Year of Visit

Timestamp (Unix)

The year the visit began.

Default

duration

Duration of Visit

Duration (Seconds)

The visit's duration in seconds.

Default

referrertype

Referrer Type

The visit's referrer type: Direct, Search Engine, Social Networks, Email, Back Links, Internal, or PPC.

Default

referrerquery

Referrer Query (search referrals)

Text

The search engine query, or the click identifier (such as gclid) for PPC. It may show as -encrypted- because HTTPS referrer data is limited for privacy.

Default

referrerurl

Referrer URL

Text

The referrer's URL. It may not include the path and query, because HTTPS referrer data is limited for privacy.

Default

landingpage

Landing Page Path

Text

The URL path of the visit's first page view.

Default

actions

Total # of Events per Visit

Number

The number of events in the visit.

Default

is_first

Is First Visit

Short Boolean

Whether this is the user's first visit.

Default