Building funnels with event tracking

Track user actions with Onside.track and build funnels over these events.

Attribution answers “where did the user come from?”.

See Attribution.

Event tracking answers “what did the user do next?”.

Use Onside.track(_:parameters:) to log user actions. You can then build funnels over these events.

API

Onside.track(
    _ event: OnsideEvent,
    parameters: [OnsideEventParameter: OnsideEventParameterValue]
)

Pass parameters: [:] if you do not need any metadata.

Events

OnsideEvent ships with a set of common event constants. You can also send any custom event name.

• Use .levelAchieved, .purchaseCompleted, .registrationCompleted, and other predefined cases when they match your action.

• Use .custom("...") or a string literal for everything else.

OnsideEvent is ExpressibleByStringLiteral, so this works:

Onside.track("my_custom_event", parameters: [:])

Predefined OnsideEvent cases

public enum OnsideEvent: Sendable, ExpressibleByStringLiteral {
    case levelAchieved
    case purchaseCompleted
    case registrationCompleted
    case tutorialCompleted
    case subscriptionStarted
    case subscriptionRenewed
    case subscriptionCancelled
    case profileUpdated
    case contentViewed
    case contentShared
    case searchPerformed
    case addedToCart
    case checkoutStarted
    case paymentInfoEntered
    case custom(String)
}

Parameters

OnsideEventParameter is the key type for event metadata.

It behaves like events:

• It includes a prepared set of common parameter keys.

• It does not limit your API. You can always use a custom key.

• It is ExpressibleByStringLiteral.

OnsideEventParameterValue supports:

• String, Double, Int, Bool

• arrays of these types

Full list of predefined OnsideEventParameter keys

public enum OnsideEventParameter: Sendable, Hashable, ExpressibleByStringLiteral {
    case achievementId
    case level
    case score
    case success
    case price
    case contentType
    case contentId
    case contentList
    case currency
    case quantity
    case registrationMethod
    case paymentInfoAvailable
    case maxRatingValue
    case ratingValue
    case searchString
    case dateA
    case dateB
    case destinationA
    case destinationB
    case description
    case `class`
    case eventStart
    case eventEnd
    case lat
    case long
    case customerUserId
    case validated
    case revenue
    case projectedRevenue
    case receiptId
    case tutorialId
    case virtualCurrencyName
    case deepLink
    case oldVersion
    case newVersion
    case reviewText
    case couponCode
    case orderId
    case param1
    case param2
    case param3
    case param4
    case param5
    case param6
    case param7
    case param8
    case param9
    case param10
    case departingDepartureDate
    case returningDepartureDate
    case destinationList
    case city
    case region
    case country
    case departingArrivalDate
    case returningArrivalDate
    case suggestedDestinations
    case travelStart
    case travelEnd
    case numAdults
    case numChildren
    case numInfants
    case suggestedHotels
    case userScore
    case hotelScore
    case purchaseCurrency
    case preferredStarRatings
    case preferredPriceRange
    case preferredNeighborhoods
    case preferredNumStops
    case custom(String)
}

Validation rules

OnsideKit validates events and parameters before sending them.

Event names and parameter keys

• Must match ^[a-zA-Z][a-zA-Z0-9_]*$ — start with a letter; letters, digits, and underscores only.

• Are truncated to 40 characters.

• Must not start with the reserved prefixes onside_ or $$.

A name or key that breaks these rules is dropped (a warning is logged to the console): an invalid event name drops the whole event; an invalid parameter key drops only that parameter.

Parameter values and limits

• String values are truncated to 100 characters.

• An event may carry at most 25 effective parameters; any beyond that are ignored. Array elements each count toward this limit.

• Array values may contain only scalars (String, Double, Int, Bool) — no nested arrays.

Example

import OnsideKit

// Use predefined event + predefined parameters.
Onside.track(
    .purchaseCompleted,
    parameters: [
        .price: 4.99,
        .currency: "EUR",
        .quantity: 1,
        .validated: true
    ]
)

// Use predefined event + custom parameter key (string literal).
Onside.track(
    .contentViewed,
    parameters: [
        .contentId: "post_123",
        "screen": "home"
    ]
)

// Fully custom event + custom parameters.
Onside.track(
    "my_custom_event",
    parameters: [
        "ab_test_variant": "B",
        "scores": [10, 20, 30]
    ]
)