Screen

The screen event category enables you to understand how a user is navigating your native mobile and desktop apps.

You will notice that the user is required, but the customer is optional. screen events are undertaken by a user, but not nessicarily bound to a customer account. It is recommended to include the customer id whenever the screen being viewed is associated with a customer account.

​

Event format

Screen events are identified with category=screen.

​

Viewing a mobile dashboard

{
    "category": "screen",
    "user": { 
        "id": "123" 
    },
    "customer": { 
        "id": "12"
    },
    "key": "dashboard.view",
    "meta": {
        "app": {
            "version": "3.0.5"
        },
        "device": {
            "type": "mobile"
        },
        "os": {
            "type": "Android",
            "version": "13"
        },
    },
}