Track Page View Events

After integrating the SDK, you can log the users' page view events by calling setPageProperties([String: Any]) and sending all page related information as key=value properties.

How persistence works:

The SDK does not store or persist any default page properties. However, once setPageProperties is called with values, those properties are persisted and automatically included in the page node of all subsequent SDK calls — including events, user properties, and other payloads — until they are explicitly changed. To update page properties, call setPageProperties again with the new values. To remove page properties, pass empty values.

Why use it?

• Page Context: Provides context about what page or screen the user is viewing when events occur.
• User Journey Tracking: Enables tracking user navigation patterns through your app.
• Content Analytics: Helps analyze which pages/screens are most engaging for users.

Note

If page properties are never set, no page property is included in the event payload. Once set, they persist across subsequent calls until updated or cleared.

Syntax

Collect.getInstance()?.setPageProperties(_ properties: [String: Any], _ callback: ResponseCallback?)

Parameters

Parameter	Type	Required	Description
properties	[String: Any]	Yes	This indicates the page specific properties
callback	ResponseCallback?	Optional	Callback to handle function response

Usage Examples

var pageProperties = [
    "name": "Product Details",
    "category": "E-commerce"
]

Collect.getInstance()?.setPageProperties(pageProperties)

The detailed page properties will be passed in the payload:

Detailed page properties in payload

    "events": [
        {
        "event": {
            "eventName": "pageView",
            "eventTimestamp": 1745959356443
        },
        "user": {
            "zi": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
        },
        "page": {
            "name": "Product Details",
            "category": "E-commerce"
        },
        "version": "1.3.8"
        }
    ]

Set page properties with callbacks

You can also set page properties with Callback function as shown below. The data parameter is an object that contains status and message which helps to debug the status of the function call.

Collect.getInstance()?.setPageProperties([
    "name": "Product Details",
    "category": "E-commerce"
], {data in 
    // Implement function to handle response
    // [status: "SUCCESS", message: "User identities set successfully"]
})

Best Practices

1. Call on Screen Load: Set page properties when a new screen/view becomes visible to the user.

2. Consistent Naming: Use consistent naming conventions for similar screens across your app.

3. Relevant Context: Include properties that provide meaningful context about the current screen.

4. Avoid Sensitive Data: Don't include sensitive information like passwords or personal details.

5. Update on Navigation: Update page properties each time the user navigates to a different screen.