Getting Started with Experience Analytics

This quick start guide shows you how to get Contentsquare Experience Analytics set up in an iOS application.

Use the Contentsquare wizard or skills to set up, update, and configure iOS with your AI coding assistant.

npx @contentsquare/wizard install

Use this path when you prefer to configure your AI coding assistant yourself.

Choose how to install the Contentsquare skill.

copilot plugin marketplace add ContentSquare/agents
copilot plugin install contentsquare-ios@contentsquare

/plugin marketplace add ContentSquare/agents
/plugin install contentsquare-ios@contentsquare

npx skills add contentsquare/agents

After installing the skill, paste this prompt into your AI coding assistant:

Install Contentsquare for iOS.

Prefer to set things up manually? Continue with the steps below.

After completing the setup process, you'll be able to take full advantage of the CSQ API to collect data from your app, within just a few minutes.

This guide assumes you are using Xcode with Swift Package Manager ↗ to manage external dependencies.

1. In your Xcode project > Package Dependencies, add this repository location:

   https://github.com/ContentSquare/apple-sdk.git

2. Set the Dependency Rule to Exact Version 1.12.3.

3. Select Add Package.

4. To ensure the library can start properly, add -ObjC as a linker flag under Build Settings > Linking - General > Other Linker Flags.

1. Import the ContentsquareSDK module in AppDelegate:

   import UIKit
   import ContentsquareSDK
   
   @UIApplicationMain
   class AppDelegate: UIResponder, UIApplicationDelegate {
     var window: UIWindow?
   
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
       ...
     }
   }

2. Add a call to CSQ.start():

   • Experience Analytics
   • CSQ Experience Platform (Early Access)

     Get Early Access to CSQ Experience Platform, our latest, all-in-one offering.

     Reach out to your Customer Success Manager to join the Early Access Program.

   import UIKit
   import ContentsquareSDK
   
   @UIApplicationMain
   class AppDelegate: UIResponder, UIApplicationDelegate {
     var window: UIWindow?
   
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
       CSQ.start()
       return true
     }
   
   }

3. Implement the optIn() API to forward user consent to the SDK, generate a user ID, and initiate tracking.

   • Experience Analytics
   • CSQ Experience Platform (Early Access)

     Get Early Access to CSQ Experience Platform, our latest, all-in-one offering.

     Reach out to your Customer Success Manager to join the Early Access Program.

   import UIKit
   import ContentsquareSDK
   
   // In viewDidLoad()
   optinButton.addTarget(self, action: #selector(optInButtonTapped), for: .touchUpInside)
   
   @objc func optInButtonTapped(_ sender: UIButton) {
     CSQ.start()
     CSQ.optIn()
     // Continue with post-consent navigation or UI update
   }

4. Start your application, and check logs for this output:

   [INFO] CSQ 1.12.3 for Experience Analytics is attempting to start.

Contentsquare aggregates the user behavior and engagement at the screen level. Start your SDK implementation by tracking key screens like the home screen, product list, product details, or conversion funnel.

Once tracking has started, you're able to take full advantage of the CSQ SDK API to track screen views, monitor user interactions, and capture app behavior data.

Contentsquare Experience Analytics also comes with powerful Session Replay and Error Monitoring capabilities as paid options.

Screen tracking is achieved by sending a screenview event:

• Right after the SDK has started
• When the screen appears
• When a modal/pop-up is closed and the user is back on the screen
• When the app is put in the foreground (after an app hide)

As a general rule of thumb, you should send your screenviews in viewWillAppear(_ animate: Bool) when using UIKit, in .onAppear() when using SwiftUI.

import ContentsquareSDK

CSQ.trackScreenview(String, cvars: [CustomVar] = [])

For more information see Implementation recommendations

While screen tracking gives an overview of user navigation, capturing session, screen, or user metadata provides a deeper understanding of the context behind user behavior.

Our SDK offers a wide range of features to enhance your implementation, including Session Replay, Error Monitoring, extended tracking capabilities, and personal data masking.

Proceed with these how-to's to refine your implementation.