Getting Started with Product Analytics

Use this quick start guide to set up a new instance of Contentsquare's Product Analytics SDK 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.

Once you've completed the setup process, the Contentsquare SDK will capture a wide variety of user interactions in your application with no additional code required.

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. Configure and start the SDK with CSQ.start().

   • Product 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(
         environmentID: "YOUR_ENVIRONMENT_ID"
       )
     }
   }

2. For UIKit and SwiftUI Enable screenviews and event autocapture.

   • Product 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.

   CSQ.start(
     environmentID: "YOUR_ENVIRONMENT_ID",
     options: [
       .enableNativeAutocapture: true
     ]
   )

3. (Optional) If your Product Analytics environment is hosted in the EU, set the baseURL option to "https://mh.ba.contentsquare.net".

   • Product 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.

   CSQ.start(
     environmentID: "YOUR_ENVIRONMENT_ID",
     options: [
       .baseURL: "https://mh.ba.contentsquare.net"
     ]
   )

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

   • Product 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(environmentID: "YOUR_ENVIRONMENT_ID")
     CSQ.optIn()
     // Continue with post-consent navigation or UI update
   }

   Once tracking has started, you're able to take full advantage of the CSQ SDK API to identify users, track custom events, and more.

   Contentsquare's Product Analytics module will also automatically start tracking a wide range of user interactions, view controller changes, and app version changes without any additional code.

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

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

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

Session Replay and Error Monitoring are both available with the Experience Analytics extension, which you can purchase separately.