Topsort Analytics/com.topsort.analytics.model/Page

Page

data class Page : JsonSerializable(source)

Represents the page context where an event occurred.

Use the Factory methods to create instances:

Factory.build for simple page types
Factory.buildWithId for pages with an identifier
Factory.buildWithValues for pages with multiple values (e.g., category paths)

JSON Serialization Note: Both value (single string) and values (list) serialize to the same JSON key "value". The API distinguishes between them by JSON type:

Single value: "value": "search query"
Multiple values: "value": ["Electronics", "Phones"] This is intentional per the Topsort API contract.

Types

object Factory

Properties

val pageId: String?

Optional page identifier.

val type: String

The type of page. Typically one of: "home", "category", "PDP", "search", "cart", "other". Use PageType enum values for type safety.

val value: String?

Optional single value associated with the page (e.g., search query, product ID). Mutually exclusive with values.

val values: List<String>?

Optional list of values associated with the page (e.g., category hierarchy). Mutually exclusive with value.

Functions

open override fun toJsonObject(): JSONObject