Track events and attribute installs across Meta, TikTok, Google Ads, and Apple Search Ads from native iOS apps. Resolve deferred deep links to route users to the right content after install.

• Track standard and custom events across ad platforms
• Track revenue events with currency and value
• Resolve deferred deep links after install to route users to the right screen
• Support Apple Search Ads attribution signals when available
• Retrieve the AppCat device ID and attribution data

Store your credentials in Xcode scheme environment variables or Info.plist, then read them at runtime.

Initialize the SDK with your credentials. This automatically creates the attribution profile and resolves any deferred deep links.

import AppCat

try await AppCat.configure(
    apiKey: ProcessInfo.processInfo.environment["APPCAT_API_KEY"] ?? "",
    appId: ProcessInfo.processInfo.environment["APPCAT_APP_ID"] ?? ""
)

configure() returns a response with deep link params from the matched ad click URL. Use this to route users to the right screen on first open.

let response = try await AppCat.configure(
    apiKey: ProcessInfo.processInfo.environment["APPCAT_API_KEY"] ?? "",
    appId: ProcessInfo.processInfo.environment["APPCAT_APP_ID"] ?? ""
)
if let params = response.deepLinkParams {
    // route user based on params
    print(params)
}

Response:

AppCat.sendEvent("Purchase", params: ["item": "premium_plan"])
AppCat.sendEvent("ViewContent", params: ["category": "shoes", "productId": "SKU-100"])
AppCat.sendEvent("CompleteRegistration")

AppCat.sendEvent("Purchase", params: [
    "item": "annual_plan",
    "value": 49.99,
    "currency": "USD"
])

try await AppCat.setTrackingConsent(false)

Call this after ATT, GDPR, or an in-app privacy choice. When consent is denied, AppCat avoids forwarding certain PII fields to ad networks on your behalf.

let deviceId = AppCat.getAppCatId()
let attribution = AppCat.getAttribution()

Apple Search Ads attribution signals are collected when available during SDK initialization. No app-side setup is required.

In Xcode, go to File > Add Package Dependencies and enter:

https://github.com/AppCat-AI/appcat-ios-sdk.git

Or add it to your Package.swift:

dependencies: [
    .package(url: "https://github.com/AppCat-AI/appcat-ios-sdk.git", from: "0.1.0"),
]

Then add "AppCat" to your target's dependencies.

Add the following to your Podfile:

pod 'AppCat', :git => 'https://github.com/AppCat-AI/appcat-ios-sdk.git', :tag => '0.1.0'

Then run pod install.

The Swift package and CocoaPods pod wrap the closed-source AppCatCoreKit.xcframework binary.

import SwiftUI
import AppCat

@main
struct MyApp: App {
    init() {
        Task {
            do {
                let response = try await AppCat.configure(
                    apiKey: ProcessInfo.processInfo.environment["APPCAT_API_KEY"] ?? "",
                    appId: ProcessInfo.processInfo.environment["APPCAT_APP_ID"] ?? ""
                )
                if let params = response.deepLinkParams {
                    // Route the user based on params.
                }
                _ = response.geo
            } catch {
                // Handle setup failure.
            }
        }
    }

    // Identify — call post-login when PII becomes available
    func onLogin(userId: String, email: String) {
        Task {
            try await AppCat.identify([
                "userId": userId,
                "email": email,
                // "revenueCatIds": ["rc_user_123"],
            ])
        }
    }

    func onPurchase() {
        AppCat.sendEvent("Purchase", params: [
            "item": "premium_plan",
            "value": 9.99,
            "currency": "USD"
        ])
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Initialize the SDK and create the attribution profile. Automatically resolves deferred deep links and returns any matched query params. Must be called before any other method.

Parameters:

Returns: async throws -> AppCatInitResponse — { deepLinkParams: [String: String]?, geo: AppCatGeoResponse? }.

Response:

Example:

let response = try await AppCat.configure(
    apiKey: ProcessInfo.processInfo.environment["APPCAT_API_KEY"] ?? "",
    appId: ProcessInfo.processInfo.environment["APPCAT_APP_ID"] ?? "",
    isDebug: true,
    logLevel: .debug
)

Enrich the user profile with additional information. Call after login, signup, or whenever new user data is available.

Parameters:

Returns: async throws -> AppCatIdentifyResponse

Response:

Example:

let result = try await AppCat.identify([
    "userId": "user_123",
    "email": "[email protected]",
    "name": "Jane Smith",
    "revenueCatIds": ["rc_user_123"]
])

Track a conversion event. This method never throws.

Parameters:

Returns: Void

Example:

AppCat.sendEvent("Subscribe", params: [
    "plan": "annual",
    "value": 99.99,
    "currency": "USD",
    "eventId": "order-abc-123"
])

Get cached attribution data. Returns nil if neither configure() nor identify() has been called.

Returns: [String: Any]?

Get cached device context.

Returns: [String: Any]?

Get the stable AppCat device identifier.

Returns: String

Check if the SDK has been remotely disabled.

Returns: Bool

Check whether the SDK has been configured.

Returns: Bool

Set log verbosity at runtime.

Parameters:

Returns: Void

Record the user's tracking-consent choice.

Returns: async throws -> Void

Apple Search Ads attribution signals are collected when available during SDK initialization. If you request ATT or collect user consent elsewhere, call setTrackingConsent(_:) with the user's choice. Do not log raw attribution, deep-link params, email, or phone in production.

Custom event names are also supported as any string value.

MIT -- see LICENSE for details.