analytics domain

set_analytics_enabled

Stories addressed

• Enables or disables the use of analytics. The default state of native apps is to have analytics disabled.

• Users need to be uniquely identified for analytics purposes. Note that user identifiers must be not represent or be tied to personal information.

Treatment of analytics events before set_analytics_enabled is called

• Native apps should "queue" analytics events (for example app launch events) for sending and retain them during the current session until set_analytics_enabled is called with an is_enabled value of true, at which point sending the queued analytics events to backend servers is triggered.

URL

liquidstate://analytics/set_analytics_enabled?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
is_enabled	Boolean	Yes	Determines whether native apps should initiate analytics event tracking
user_id	String	Yes	Sets the unique identifier to use for analytics purposes for the current user.

Response

No response, the native app will simply enable or disable the sending of analytics events to backend servers.

set_super_properties

Stories addressed

• Set or reset the list of properties that should be automatically added to any analytics event.

URL

liquidstate://analytics/set_super_properties?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
properties	Object	Yes	JSON object (pairs of keys and values)

Response

No response, the native app will internally update its list of super properties to be used for future analytics events.

add_super_properties

Stories addressed

• Augment the list of properties that should be automatically added to any analytics event.

URL

liquidstate://analytics/add_super_properties?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
properties	Object	Yes	JSON object (pairs of keys and values)

Response

No response, the native app will internally update its list of super properties to be used for future analytics events.

remove_super_properties

Stories addressed

• Remove the use of some properties that should be automatically added to any analytics event.

URL

liquidstate://analytics/remove_super_properties?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
properties	Object	Yes	JSON object (pairs of keys and values)

Response

No response, the native app will internally update its list of super properties to be used for future analytics events.

post

Stories addressed

• Track an analytics event

URL

liquidstate://analytics/post?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
name	String	Yes	The name of the event
properties	Object	Yes	JSON object (pairs of keys and values)

Response

No response, the native app will internally update its list of super properties to be used for future analytics events.