Introduction

Welcome to Kalman Analytics API. Your can use this API to access Kalman endpoints and feed data to consult and analyse in your analytics dashboard.

We have language bindings in Objective-C, Swift, Java, and CSharp! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right. Contact support@kalmanlabs.com for more details if you need help setting up your specific project.

Configuration

To instantiate the SDK, use this code:

// Create a Kalman instance
Kalman *kalman = [Kalman sharedInstanceWithToken:@"MY_API_KEY" 
  AppID:@"MY_APP_ID"];

Kalman.initialize(token: "MY_API_KEY", appID: "MY_APP_ID)

// 
// Initialize the library with your Kalman project token,
// MY_API_KEY, your API Key, MY_APP_ID and a reference to your
// application context.
Kalman kalman =
    Kalman.getInstance(context, MY_APP_ID, MY_API_KEY);

Make sure to replace MY_API_KEY with your API key and MY_APP_ID.

Kalman Analytics uses API keys and APP ID to allow access to the API. You can register a new Kalman API key at our developer portal.

User Tracking

// Set customer User ID. Note that if this is not set, a random user uuid will be generated for your player
[kalman configureUserId:@"123"];
[kalman.user set:@{@"channel": @"campaign_32"}];

kalman.configureUserId(userID: "1")
kalman.registerSuperProperties(["channel": "campaign_32"])

kalman.configureUserId(userID: "1")
JSONObject props = new JSONObject();
props.put("channel", "campaign_32");
kalman.registerSuperProperties(props);

// Associate all future events sent from
// the library with the distinct_id 12345
Kalman.Identify('12345');
// Sets user 12345's "Plan" attribute to "Premium"
Kalman.People.Set("Plan", "Premium");
// Here we increment the user's point count by 500.
Kalman.People.Increment("point count", 500);

Kalman SDK allows you to set user level configuration. This is could used to capture channel of acquisition or some in game characteristics.

Note that if no userID is set, the user is automatically assigned a uuid.

Track Event

Track Purchase Event

Kalman *kalman = [Kalman sharedInstance];
[kalman trackPurchaseWithCurrency:@"USD" 
  amount:999
  itemID:@"gems"
  quantity:20];

Kalman.trackPurchase(
  currency: "USD", 
  amount: 999,
  itemID: "gems",
  quantity: 20
)

kalman.trackPurchase(
  "USD", 
  999,
  "gems",
  20
)

var props = new Value();
props["currency"] = "USD";
props["amount"] = 999;
props["itemID"] = "gems";
props["quantity"] = 20;
Kalman.trackPurchase(props)

Purchase events are used to track information related to monetization of the app. When recording a purchase event. You will need to specify the following fields

Track Ads Event Event

Kalman *kalman = [Kalman sharedInstance];
[kalman trackAdsEventWitType:@"rewarded_video"
   adProvider:@"unity"];

Kalman.trackAdsEvent(
  type: "rewarded_video", 
  adProvider: "unity"
)

kalman.trackAdsEvent(
  "rewarded_video",
  "unity"
)

var props = new Value();
props["type"] = "rewarded_video";
props["adProvider"] = "unity";
Kalman.tackAdsEvent(props);

Ads events are used to track information related to ads display. When recording a ads event. You will need to specify the following fields

Track Level Progression Event

Kalman *kalman = [Kalman sharedInstance];
[kalman trackProgressionEventWithLevel:@"level_01_03"
   status:@"finished"];

Kalman.trackProgressionEventWithLevel(
  level: "level_01_03", 
  status: "finished"
)

Kalman.trackProgressionEvent(
  "level_01_03", 
  "finished"
)

var props = new Value();
props["level"] = "level_01_03";
props["status"] = "finished";
Kalman.trackProgressionEventWithLevel(props);

Level progression events helps you track your player throughout the game. While we only support a string as a level, you can track sub_levels by giving a unique name to each sublevel (level1_part1)

Track Custom Event

Kalman *kalman = [Kalman sharedInstance];
[kalman trackWithEvent:@"Some Event" metadata:@{
    @"someProperties": @"Test"
}];

kalman.track(event: "SomeEvent",
  metadata: ["someProperties" : "Test"])

JSONObject metadata = new JSONObject();
props.put("channel", "campaign_32");
kalman.track("SomeEvent",
  metadata)

var props = new Value();
props["channel"] = "campaign_32";
Kalman.track("SomeEvent", props);

The Kalman SDK provides the ability to report custom events. You can pass to it a list of key/values. While you can use custom events to track every event describe below, we recommend to only use custom events for events that don't fall in the scope of the previous events. Using custom event makes indexing and building report slower.