Install Simple Analytics with Swift

Download PDF

Add privacy friendly analytics to your iOS apps.

Thanks to Roel van der Kraan for writing this package. See github.com/simpleanalytics/swift-package for its source.

Installation

When using Xcode to add the package dependency add this repository via File > Add package dependency: https://github.com/simpleanalytics/swift-package.git

Or when working with a package manifest use:

.package(url: "https://github.com/simpleanalytics/swift-package.git", from: "0.3.0")

Usage

You’ll need a Simple Analytics account to be able to use this package. See Simple Analytics for more info.

Import the library:

import SimpleAnalytics

You will need the hostname of a Simple Analytics website to start an instance of SimpleAnalytics in your app. You can add a fake “website” to Simple Analytics specifically for your app. There is no need to point to a real server. You can use something like mobileapp.yourdomain.com. Skip the HTML validation by clicking “I installed the script”. ⚠️ Make sure the hostname you set in Swift matches the website domain name in Simple Analytics (without http:// or https://).

let simpleAnalytics = SimpleAnalytics(hostname: "mobileapp.yourdomain.com")

You can create an instance where you need it, or you can make an extension and use it as a static class.

import SimpleAnalytics

extension SimpleAnalytics {
    static let shared: SimpleAnalytics = SimpleAnalytics(hostname: "mobileapp.yourdomain.com")
}

Tracking

You can call the tracking functions from anywhere in your app.

Tracking Pageviews

Use pageviews to track screens in your app.

SimpleAnalytics.shared.track(path: ["list"])

To represent a hierarchy in your views, add every level as an entry in the path array:

SimpleAnalytics.shared.track(path: ["detailview", "item1", "edit"])

This will be converted to a pageview on /detailview/item1/edit on Simple Analytics.

Tracking Events

Use events to track interactions or noticable events like errors or success on a page.

SimpleAnalytics.shared.track(event: "logged in")

You can provide an optional path to track alongside the event.

SimpleAnalytics.shared.track(event: "logged in", path: ["login", "social"])

Examples

SwiftUI example

In SwiftUI, a good place to put the Pageview tracking code is in your view .onAppear{} modifier.

import SwiftUI
import SimpleAnalytics

struct ContentView: View {
    var body: some View {
        VStack {
            Image(systemName: "globe")
                .imageScale(.large)
                .foregroundStyle(.tint)
            Text("Hello, world!")
        }
        .padding()
        .onAppear {
            SimpleAnalytics.shared.track(path: ["example"])
        }
    }
}

UIKit example

When using UIKit, you can put Pageview tracking in viewDidAppear()

import UIKit
import SimpleAnalytics

class ExampleViewController: UITableViewController {
    override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)
        SimpleAnalytics.shared.track(path: ["example"])
    }
}