Setting the file. One moment.
Chapter 147 · Integration Swift
Subchapter 147.7
references/ios.mdMarkdown5 KBView on GitHub
The PostHog iOS SDK is a library that you can use to track events, identify users, record session replays, evaluate feature flags, run experiments, build surveys, and more.
This page shows you how to install the SDK and get started with it. If you’ve already installed the SDK, you can skip ahead to learn about using the features and .
PostHog is available through CocoaPods (opens in a new tab) or you can add it as a Swift Package Manager based dependency.
Podfile
PostHog AI
pod "PostHog", "~> 3.0"Add PostHog as a dependency in your Xcode project “Package Dependencies” and select the project target for your app, as appropriate.
For a Swift Package Manager based project, add PostHog as a dependency in your Package.swift file’s Package dependencies section:
Package.swift
PostHog AI
dependencies: [
.package(url: "https://github.com/PostHog/posthog-ios.git", from: "3.0.0")
],and then as a dependency for the Package target utilizing PostHog:
Package.swift
PostHog AI
.target(
name: "myApp",
dependencies: [.product(name: "PostHog", package: "posthog-ios")]),Configuration is done through the PostHogConfig object. Here’s a basic configuration example to get you started.
You can find more advanced configuration options in the configuration page (opens in a new tab).
Swift
PostHog AI
import Foundation
import PostHog
import UIKit
class AppDelegate: NSObject, UIApplicationDelegate {
func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
let POSTHOG_API_KEY = "<ph_project_token>"
// usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
let POSTHOG_HOST = "https://us.i.posthog.com"
let config = PostHogConfig(apiKey: POSTHOG_API_KEY, host: POSTHOG_HOST)
PostHogSDK.shared.setup(config)
return true
}
}Swift
PostHog AI
import SwiftUI
import PostHog
@main
struct YourGreatApp: App {
// Add PostHog to your app's initializer.
// If using UIApplicationDelegateAdaptor, see the UIKit tab.
init() {
let POSTHOG_API_KEY = "<ph_project_token>"
// usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
let POSTHOG_HOST = "https://us.i.posthog.com"
let config = PostHogConfig(apiKey: POSTHOG_API_KEY, host: POSTHOG_HOST)
PostHogSDK.shared.setup(config)
}
var body: some Scene {
WindowGroup {
ContentView()
}
}
}Identifying users is required. Call
posthog.identify('your-user-id')after login to link events to a known user. This is what connects frontend event captures, session replays (opens in a new tab), LLM traces (opens in a new tab), and error tracking (opens in a new tab) to the same person — and lets backend events link back too.See our guide on identifying users (opens in a new tab) for how to set this up.
The PostHog iOS SDK will continue to capture events when the device is offline. The events are stored in a queue in the device’s file storage and are flushed when the device is online.
maxQueueSize in the configuration.You can find the options for configuring the offline behavior in the configuration page (opens in a new tab).
PostHog supports sharing analytics data between your main app and application extensions (such as widgets, app clips, share extensions, and custom keyboards) through App Groups. This ensures that users maintain the same identity across all parts of your app ecosystem.
By default, each iOS app target stores its data in its own sandboxed directory. This means that if a user interacts with your main app and then uses a widget or extension, PostHog would treat them as two different anonymous users. This can lead to:
The PostHog iOS SDK uses method swizzling to intercept and modify method calls at runtime to provide advanced features like screen view tracking, element interactions, session replay, surveys, and more.
Method swizzling is particularly important for accurate session metrics tracking. When disabled, the SDK cannot capture optimal session metrics.
You can learn more about configuring method swizzling in the configuration page (opens in a new tab).
Now that you’ve installed the SDK, explore the configuration and usage options:
Ask a question
HelpfulCould be better