PythonAPI reference
In-app messages
In-app messages — modals and banners composed in the console.
// access
client.inappIn-app messages — modals and banners composed in the console.
The client SDKs render them. Server-side you fetch what a user is eligible for (headless / server-driven UIs) and record impressions, clicks and dismissals.
InApp
classclient.inapp
Extends Resource.
active()
methoddef active(*, distinct_id=None, device_key=None) -> List[Any]The tenant's active in-app messages.
Parameters
Prop
Type
Returns List[Any]
track_event()
methoddef track_event(message_id, type, *, button_id=None, distinct_id=None) -> Dict[str, Any]Record impression, click or dismiss.
Parameters
Prop
Type
Returns Dict[str, Any]
impression()
methoddef impression(message_id, **options) -> Dict[str, Any]Parameters
Prop
Type
Returns Dict[str, Any]
click()
methoddef click(message_id, button_id, **options) -> Dict[str, Any]Parameters
Prop
Type
Returns Dict[str, Any]
dismiss()
methoddef dismiss(message_id, **options) -> Dict[str, Any]Parameters
Prop
Type
Returns Dict[str, Any]