Skip to content

Latest commit

 

History

History
173 lines (120 loc) · 6.82 KB

README.md

File metadata and controls

173 lines (120 loc) · 6.82 KB
Raw

PiwikTracker iOS SDK

The PiwikTracker is an iOS, tvOS and macOS SDK for sending app analytics to a Piwik server.

Fancy help improving this SDK? Check this list to see what is left and can be improved.

Build Status

Installation

CocoaPods

Use the following in your Podfile.

pod 'PiwikTracker', '~> 4.1.0'

Then run pod install. In every file you want to use the PiwikTracker, don't forget to import the framwork with import PiwikTracker.

Usage

Configuration

Befor the first usage, the PiwikTracker has to be configured. This is best to be done in the application(_:, didFinishLaunchingWithOptions:) method in the AppDelegate.

PiwikTracker.configureSharedInstance(withSiteID: "5", baseURL: URL(string: "http://your.server.org/path-to-piwik/piwik.php")!)

The siteId is the id that you can get if you add a website within the Piwik web interface. The baseURL it the URL to your Piwik web instance and has to include the "piwik.php" string.

OptOut

The PiwikTracker SDK supports opting out of tracking. Please use the isOptedOut property of the PiwikTracker to define if the user opted out of tracking.

PiwikTracker.shared?.isOptedOut = true

Tracking Page Views

The PiwikTracker can track hierarchical screen names, e.g. screen/settings/register. Use this to create a hierarchical and logical grouping of screen views in the Piwik web interface.

PiwikTracker.shared?.track(view: ["path","to","your","page"])

You can also set the url of the page.

let url = URL(string: "https://piwik.org/get-involved/")
PiwikTracker.shared?.track(view: ["community","get-involved"], url: url)

Tracking Events

Events can be used to track user interactions such as taps on a button. An event consists of four parts:

  • Category
  • Action
  • Name (optional, recommended)
  • Value (optional)
PiwikTracker.shared?.track(eventWithCategory: "player", action: "slide", name: "volume", value: 35.1)

This will log that the user slided the volume slider on the player to 35.1%.

Custom Dimension

The Piwik SDK currently supports Custom Dimensions for the Visit Scope. Using Custom Dimensions you can add properties to the whole visit, such as "Did the user finish the tutorial?", "Is the user a paying user?" or "Which version of the Application is being used?" and such. Before sending custom dimensions please make sure Custom Dimensions are properly installed and configured. You will need the ID of your configured Dimension.

After that you can set a new Dimension,

PiwikTracker.shared?.set(value: "1.0.0-beta2", forIndex: 1)

or remove an already set dimension.

PiwikTracker.shared?.remove(dimensionAtIndex: 1)

Dimensions in the Visit Scope will be sent along every Page View or Event. Custom Dimensions are not persisted by the SDK and have to be re-configured upon application startup.

Advanced

Manual dispatching

The PiwikTracker will dispatch events every 30 seconds automatically. If you want to dispatch events manually, you can use the dispatch() function. You can, for example, dispatch whenever the application enter the background.

func applicationDidEnterBackground(_ application: UIApplication) {
  PiwikTracker.shared?.dispatch()
}

Session Management

The PiwikTracker starts a new session whenever the application starts. If you want to start a new session manually, you can use the startNewSession() function. You can, for example, start a new session whenever the user enters the application.

func applicationWillEnterForeground(_ application: UIApplication) {
  PiwikTracker.shared?.startNewSession()
}

Logging

The PiwikTracker per default loggs warning and error messages to the console. You can change the LogLevel.

PiwikTracker.shared?.logger = DefaultLogger(minLevel: .verbose)
PiwikTracker.shared?.logger = DefaultLogger(minLevel: .debug)
PiwikTracker.shared?.logger = DefaultLogger(minLevel: .info)
PiwikTracker.shared?.logger = DefaultLogger(minLevel: .warning)
PiwikTracker.shared?.logger = DefaultLogger(minLevel: .error)

You can also write your own Logger and send the logs whereever you want. Just write a new class/struct an let it conform to the Logger protocol.

Custom User Agent

The PiwikTracker will create a default user agent derived from the WKWebView user agent. This is why you should always instantiate and configure the PiwikTracker on the main thread. You can instantiate the PiwikTracker using your own user agent.

PiwikTracker.configureSharedInstance(withSiteID: "5", baseURL: URL(string: "http://your.server.org/path-to-piwik/piwik.php")!, userAgent: "Your custom user agent")

Objective-C compatibility

Version 4 of this SDK is written in Swift, but you can use it in your Objective-C project as well. If you don't want to update you can still use the unsupported older version 3. Using the Swift SDK from Objective-C should be pretty straight forward.

[PiwikTracker configureSharedInstanceWithSiteID:@"5" baseURL:[NSURL URLWithString:@"http://your.server.org/path-to-piwik/piwik.php"] userAgent:nil];
[PiwikTracker shared] trackWithView:@[@"example"] url:nil];
[[PiwikTracker shared] trackWithEventWithCategory:@"category" action:@"action" name:nil number:nil];
[[PiwikTracker shared] dispatch];

Contributing

Please read CONTRIBUTING.md for details.

ToDo

These features aren't implemented yet

  • Basic functionality
  • Tracking of more things
    • Exceptions
    • Social Interactions
    • Search
    • Goals and Conversions
    • Outlinks
    • Downloads
    • Ecommerce Transactions
    • Campaigns
    • Content Impressions / Content Interactions
  • Customizing the tracker
    • Custom User Agent
    • userID
    • add prefixing? (The objc-SDK had a prefixing functionality Example screenshot)
    • set the dispatch interval
    • use different dispatchers (Alamofire)

License

PiwikTracker is available under the MIT license.