Guides and Surveys iOS SDK

Amplitude's Guides and Surveys iOS SDK enables you to deploy Guides and Surveys in your iOS applications.

Requirements

The Guides and Surveys iOS SDK requires:

• User devices on iOS 15 or higher
• Swift 5.9+
• Amplitude iOS Swift SDK: 1.13.0+

Install and initialize the SDK

Guides and Surveys supports different installation options to work best with your existing Amplitude implementation, if you have one.

Using Amplitude iOS Swift 1.13.0+

First, install the Guides and Surveys iOS SDK with Swift Package Manager or CocoaPods.

pod 'AmplitudeEngagementSwift', '~> 1.6.0'

Initialize the SDK

Next, make sure to initialize the SDK.

import AmplitudeEngagementSwift


let amplitudeEngagement = AmplitudeEngagement("YOUR_API_KEY")


let configuration = Configuration(
  apiKey: API_KEY
)
let amplitude = Amplitude(configuration: configuration)
amplitude.add(plugin: amplitudeEngagement.getPlugin())

Configuration options

Add your application to project settings

After installing the SDK, add your iOS application to your Amplitude project settings so it appears as a platform option when you create guides and surveys.

To add your application:

1. Navigate to Settings > Projects in Amplitude.
2. Select your project.
3. Navigate to the General tab.
4. In the Platform section, click + Add Platform.
5. Select iOS from the platform list.
6. Enter your application details:
   • App name: Your app's display name
   • Bundle ID: Your iOS bundle identifier (for example, com.example.myapp)
7. Click Save.

After you add your application, it appears as a platform option when you create or edit guides and surveys. This enables you to target your iOS users and preview guides directly in your app.

Not using Amplitude Swift 1.13.0+

In this case, installation is very similar to above; however, you need to manually call .boot.

First, install the Guides and Surveys iOS SDK with Swift Package Manager or CocoaPods.

pod 'AmplitudeEngagementSwift', '~> 1.6.0'

Initialize the SDK

import AmplitudeEngagementSwift


let amplitudeEngagement = AmplitudeEngagement("YOUR_API_KEY")


let configuration = Configuration(
  apiKey: API_KEY
)
let amplitude = Amplitude(configuration: configuration)
amplitude.add(plugin: amplitudeEngagement.getPlugin())

Configuration options

Boot the SDK

// Basic boot with user ID
amplitudeEngagement.boot("USER_ID")

// Advanced boot with options

let bootOptions = AmplitudeBootOptions(
  user_id: "USER_ID",
  device_id: "DEVICE_ID",
  user_properties: ["key": "value"]
  integrations: [
    { event, eventProperties in
        // Custom event handler
    }
  ]
)
amplitudeEngagement.boot(options: bootOptions)

Screen tracking and element targeting

Screen tracking and element targeting are technically optional, but can be very helpful for making your guides and surveys feel more targeted.

Enable screen tracking

Required for screen-based targeting and the Time on Screen trigger. The screen string (eg "HomeScreen" in the example below) is compared with the string provided in the guide or survey page targeting section.

// Track screen views to trigger guides based on screens
amplitudeEngagement.screen("HomeScreen")

Enable element targeting

Pin and tooltip guides require the ability for the SDK to target specific elements on screen. To enable this in your app, give the element a unique identifier.

// Swift UI
MySwiftView {
    // Content
}
.amplitudeView("MySwiftView", onTrigger: {
    // Optional code to run with tap element action
}

// UIKit
let myView = MyUIKitView(...)
myView.accessibilityIdentifier = "MyView"

Other SDK Methods

Manage themes

Configure the visual theme mode if your app supports light and dark modes.

// Set the theme mode
amplitudeEngagement.setThemeMode(ThemeMode.DARK) // Options: AUTO, LIGHT, DARK

Router configuration

Configure how Guides and Surveys handles screen navigation.

engagement.setRouter { identifier in
  // Your screen handling and navigation
}

Reset

Reset a guide or survey to a specific step.

amplitudeEngagement.reset(key = "GUIDE_KEY", stepIndex = 0)

List

Retrieve a list of all live guides and surveys along with their status.

val guidesAndSurveys = amplitudeEngagement.list()

Show

Display a specific guide or survey. Ignores any targeting rules and limits except for screen targeting.

amplitudeEngagement.show(key = "GUIDE_KEY")

Forward event

If you don't use the plugin, but want to trigger Guides using events.

amplitudeEngagement.forwardEvent([
  "event_type": "my event type", 
  "event_properties": [String: String]()
])

Close all

Close all active guides and surveys.

amplitudeEngagement.closeAll()

Simulate Guides and Surveys for preview

To use preview mode to test a guide or survey in your app, configure a custom URL scheme.

Add your mobile app to project settings

Before you can use preview mode, add your iOS app to your project settings in Amplitude:

1. In Amplitude, navigate to Settings > Organization Settings > Projects.
2. Select your project.
3. Click the Guides and Surveys tab.
4. In the App Management section, click Add App.
5. Enter your iOS app's bundle ID (for example, com.example.MyApp).
6. Click Save.

After you add your app, Amplitude generates a unique URL scheme for mobile preview.

Locate the mobile URL scheme

After adding your app to project settings, locate the URL scheme:

1. In the Guides and Surveys tab of your project settings, find the URL scheme (mobile) field.
2. Copy its value, for example, amp-abc123.

Add the URL scheme in Xcode

1. Open your iOS project in Xcode.
2. In the Project navigator, select your app's target.
3. On the Info tab, locate the URL Types section.
4. Add a new URL type with the following values:
   • Identifier: Provide a descriptive name, like AmplitudeURLScheme.
   • URL Schemes: Paste the value you copied from Amplitude, for example amp-abc123.

Configure URL handling for preview links

// In your AppDelegate or SceneDelegate
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    if amplitudeEngagement.handleUrl(url) {
        return true
    }
    // Handle other URL schemes
    return false
}

Changelog

You can access the changelog here.