Configuration · Instrument Product Analytics · PostHog/skills · Skills Docs

Configuration · Instrument Product Analytics · PostHog/skills · Skills Docs

let configuration = PostHogConfig(projectToken: "<ph_project_token>", host: "https://us.i.posthog.com")
configuration.tracingHeaders = ["api.example.com"]
PostHogSDK.shared.setup(configuration)

let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")

config.setBeforeSend { event in
    // Redact URLs
    if let url = event.properties["url"] as? String {
        event.properties["url"] = url.map { _ in "*" }.joined()
    }
    return event
}

let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")

config.setBeforeSend { event in
    // Redact sensitive information
    if let email = event.properties["email"] as? String {
        event.properties["email"] = email.map { _ in "*" }.joined()
    }

    return event
}

let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")

config.setBeforeSend { event in
    // Drop all events named "Stale Event"
    if event.event == "Stale Event" {
        return nil
    }
    return event
}

let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")

let ignoredScreens: Set<String> = ["Splash", "Debug"]

config.setBeforeSend { event in
    if event.event == "$screen",
       let screenName = event.properties["$screen_name"] as? String,
       ignoredScreens.contains(screenName) {
        return nil
    }
    return event
}

let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")

config.setBeforeSend { event in
    // Sample 10% of Sampled Event events
    if event.event == "Sampled Event" {
        if Double.random(in: 0...1) < 0.1 {
            event.properties["$sample_type"] = ["sampleByEvent"]
            event.properties["$sample_threshold"] = 0.1
            event.properties["$sampled_events"] = ["Sampled Event"]
            return event
        }
        return nil
    }
    return event
}

let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")

config.setBeforeSend(
    // First block: Drop all events named "Stale Event"
    { event in
        if event.event == "Stale Event" {
            return nil
        }
        return event
    },
    // Second block: Redact sensitive information
    { event in
        if let email = event.properties["email"] as? String {
            event.properties["email"] = email.map { _ in "*" }.joined()
        }
        return event
    }
)

Feature	Description	Config option
Screen view tracking	Automatically captures when view controllers are presented	`config.captureScreenViews`
Element interactions	Automatically tracks user interactions with UI elements	`config.captureElementInteractions`
Rage clicks	Automatically captures `$rageclick` events for rapid repeated taps in the same area (iOS/macCatalyst, UIKit)	`config.rageClickConfig.enabled`
Session replay	Records user sessions	`config.sessionReplay`
Surveys	Displays surveys at appropriate times	`config.surveys`
Advanced metrics tracking	Provides more precise session ID calculation and rotation by detecting user activity and idleness	N/A

Attribute	Description
`flushAt` Type: Integer Default: `20` (`5` on tvOS)	The number of queued events that the posthog client should flush at. Setting this to `1` will not queue any events and will use more battery.
`flushIntervalSeconds` Type: TimeInterval Default: `30`	The amount of time to wait before each tick of the flush timer, in seconds. Smaller values will make events delivered in a more real-time manner and also use more battery. A value smaller than 10 seconds will seriously degrade overall performance.
`maxQueueSize` Type: Integer Default: `1000` (`100` on tvOS)	The maximum number of items to queue before starting to drop old ones. This should be a value greater than zero, the behavior is undefined otherwise.
`maxBatchSize` Type: Integer Default: `50`	Number of maximum events in a batch call.
`maxRetries` Type: Integer Default: `3`	Maximum number of consecutive flush attempts before the entire queue is dropped to avoid infinite retries against a permanently-broken backend (e.g. wrong API key, exhausted quota, deterministic 5xx). Increments on every retriable failure including HTTP 413 cap halving; resets on a successful 2xx response.
`captureApplicationLifecycleEvents` Type: Boolean Default: `true`	Whether the posthog client should automatically make a capture call for application lifecycle events, such as “Application Installed”, “Application Updated” and “Application Opened”.
`captureScreenViews` Type: Boolean Default: `true`	Whether the posthog client should automatically make a screen call when a view controller is added to a view hierarchy. Because the underlying implementation uses method swizzling, we recommend initializing the posthog client as early as possible (before any screens are displayed), ideally during the Application delegate’s applicationDidFinishLaunching method.
`enableSwizzling` Type: Boolean Default: `true`	Enable method swizzling for SDK functionality that depends on it. When disabled, functionality that requires swizzling (like autocapture, screen views, session replay, surveys) will not be installed.
`captureElementInteractions` Type: Boolean Default: `false`	(UIKit only) Whether the posthog client should automatically make a capture call when the user interacts with an element in a screen.
`rageClickConfig` Type: Object Default: `.init()`	(iOS/macCatalyst, UIKit) Rage click detection configuration. Includes `enabled` (default `true`), `minimumTapCount` (default `3`), `thresholdPoints` (default `30`), and `timeoutInterval` (default `1.0`). Works independently of `captureElementInteractions`. Available in version 3.51.0+.
`sendFeatureFlagEvent` Type: Boolean Default: `true`	Send a `$feature_flag_called` event when a feature flag is used automatically.
`preloadFeatureFlags` Type: Boolean Default: `true`	Preload feature flags automatically.
`evaluationContexts` Type: Array of Strings Default: `undefined`	Evaluation context tags that constrain which feature flags are evaluated. When set, only flags with matching evaluation context tags (or no evaluation context tags) will be returned. See evaluation contexts documentation (opens in a new tab) for more details. Available in version 3.38.0+. The legacy parameter `evaluationEnvironments` (version 3.33.0+) is also supported for backward compatibility.
`debug` Type: Boolean Default: `false`	Logs the SDK messages to the Xcode console.
`optOut` Type: Boolean Default: `false`	Prevents capturing any data if enabled.
`getAnonymousId` Type: Function Default: `undefined`	Hook that allows for modification of the default mechanism for generating anonymous id (which as of now is just random UUID v7).
`dataMode` Type: Enum Default: `.any`	Controls when queued data is flushed. Use `.wifi` to flush only on Wi-Fi; `.cellular` is a legacy value and behaves like `.any`.
`personProfiles` Type: Enum Default: `.identifiedOnly`	Determines the behavior for processing user profiles.
`setDefaultPersonProperties` Type: Boolean Default: `true`	Automatically set common device and app properties (such as `$app_version`, `$os_name`, and `$device_type`) as person properties for feature flag evaluation. See property overrides (opens in a new tab) for more details.
`sessionReplay` Type: Boolean Default: `false`	Enable Recording of Session Replays.
`sessionReplayConfig` Type: Object Default: `.init()`	Session Replay configuration. See Session Replay installation (opens in a new tab) for more details.
`tracingHeaders` Type: Array of Strings Default: `nil`	Exact hostnames that should receive PostHog tracing headers when the SDK instruments `URLSession` requests.
`errorTrackingConfig` Type: Object Default: `.init()`	Error Tracking configuration. See the error tracking docs (opens in a new tab) for more details.
`logs` Type: Object Default: `.init()`	Structured Logs configuration. See Logs installation (opens in a new tab) for more details.
`surveysConfig` Type: Object Default: `.init()`	Surveys configuration, including custom survey delegates and display language overrides.
`urlSessionConfiguration` Type: URLSessionConfiguration Default: `.default`	Custom `URLSessionConfiguration` used by the SDK for PostHog API requests.
`appGroupIdentifier` Type: String Default: `nil`	The identifier of the App Group that should be used to store shared analytics data. PostHog will try to get the physical location of the App Group’s shared container, otherwise fallback to the default location.
`reuseAnonymousId` Type: Boolean Default: `false`	Whether the SDK should reuse the anonymous Id between user changes. When enabled, a single Id will be used for all anonymous users on this device.
`surveys` Type: Boolean Default: `true`	Enable Surveys.
`setBeforeSend` Type: Function Default: `undefined`	Hook that allows for amending, sampling, or dropping events before they are sent to PostHog.
`bootstrap` Type: `PostHogBootstrapConfig` Default: `nil`	Seeds identity (`distinctId`, `isIdentifiedId`) and feature-flag state (`featureFlags`, `featureFlagPayloads`) before the first `/flags` response. Bootstrapped identity applies to the first session; only enabled flags are served, until the first `/flags` response replaces them. See SDK bootstrapping (opens in a new tab).