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.

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.

Before you begin

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

In your XCode project > Package Dependencies, add this repository location:
```
https://github.com/ContentSquare/apple-sdk.git
```
Set the Dependency Rule to Exact Version 1.10.0
Select Add Package
To ensure the library can start properly, add -ObjC as a linker flag under Build Settings > Linking - General > Other Linker Flags

Add the following line to your Podfile:
Podfile
```
pod 'ContentsquareSDK', '1.10.0'
```
Build your app target

Start the SDK

Configure and start the SDK with CSQ.start().

Standalone
Unified CSQ

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"
    )
  }
}

import UIKit
import ContentsquareSDK

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
  var window: UIWindow?

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    // ...

    CSQ.start(
      dataSourceID: "YOUR_DATASOURCE_ID"
    )
  }
}

For UIKit and SwiftUI Enable screenviews and event autocapture.
- Standalone
- Unified CSQ
CSQ.start( environmentID: "YOUR_ENVIRONMENT_ID", options: [ .enableNativeAutocapture: true ] )
CSQ.start( dataSourceID: "YOUR_DATASOURCE_ID", options: [ .enableNativeAutocapture: true ] )
Customize screen names to better match your analysis needs.
(Optional) If your Product Analytics environment is hosted in the EU, set the baseURL option to "https://mh.ba.contentsquare.net".
- Standalone
- Unified CSQ
CSQ.start( environmentID: "YOUR_ENVIRONMENT_ID", options: [ .baseURL: "https://mh.ba.contentsquare.net" ] )
CSQ.start( dataSourceID: "YOUR_DATASOURCE_ID", options: [ .baseURL: "https://mh.ba.contentsquare.net" ] )

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

Standalone
Unified CSQ

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
}

import UIKit
import ContentsquareSDK

// In viewDidLoad()
optinButton.addTarget(self, action: #selector(optInButtonTapped), for: .touchUpInside)

@objc func optInButtonTapped(_ sender: UIButton) {
  CSQ.start(dataSourceID: "YOUR_DATASOURCE_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.

Start your application, and check logs for this output:

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

Next steps

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

Track identity Link anonymous and identified user data across sessions and devices for comprehensive analytics

Track push notifications Track mobile notification interactions automatically

Track events manually Learn how to track custom events

Hide sensitive data Protect sensitive data by disabling text capture, masking specific views, or ignoring interactions

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

Set up the Experience Analytics extension