Upsight logo Back to top

Quick Start Guide

Engagement Tracking

What metrics are important?


  • DAU/WAU/MAU
  • Number of Pageviews
  • Number of Sessions
  • Session Length

Engagement Tracking

What API calls do I instrument to capture the metrics above?


Data Collection API Call Required Parameters Optional Parameters Where
pgrs, nocacheu Landing pages

Note For Facebook, the u parameter is pulled automatically from client side calls using Facebook fbx_type and fbx_ref references. Add the optional u parameter if you send this message server side, or if you wish to override the call.

Install Tracking

What metrics are important?


  • DAU/WAU/MAU
  • New Installs
  • Installs

Install Tracking

What API calls do I instrument to capture the metrics above?


Data Collection API Call Required Parameters Optional Parameters Where
apas None On application install

User Insights

What metrics are important?


  • Age
  • Gender
  • Location
  • Number of Friends (Facebook specific)

User Insights

What API calls do I instrument to capture the metrics above?


Data Collection API Call Required Parameters Optional Parameters Where
cpusb, g, lc, f Landing pages
pgrs, nocacheip On application install

Note The ip parameter is pulled automatically from client side calls using the machine's IP address. If you are sending this call server side, you must explicitly include the ip parameter.

Acquisition Tracking: Invites

What metrics are important?


  • Invites Sent
  • Invites Response
  • Invites Acceptance Rate
  • Invites Install

Acquisition Tracking: Invites

What API calls do I instrument to capture the metrics above?


Data Collection API Call Required Parameters Optional Parameters1 Where
inss, u, r2st1, st2, st3 Invite
inru, i3r, st1, st2, st3 Invite Response
apau, s None Invite Install

1 During app usage, users are presented with the chance to invite their friends to join them. At the time when the user invites his/her friends, the app sends the ins API call to Upsight Analytics.

2 If a recipient clicks on the link in the invitation and arrives on the app permissions landing page, the app sends the inr API call to Upsight Analytics with the same u parameter that was present in the ins call. Do not wait until an install has occurred to send the inr API call.

3 If the user then installs the application, the app sends the apa call with the sameu parameter that was in both the ins and inr calls. Proper attribution of install and virality metrics will only be tracked if the u parameter is the same across all three messages: ins, inr and apa.

Acquisition Tracking: Invites

Example API Call


ins

s=1234567&u=1111DCBA1111DCBA&r=100000432&st1=gift&st2=apple&st3=green

inr

i=0&u=1111DCBA1111DCBA&r=100000432&st1=gift&st2=apple&st3=green

apa

s=100000432&u=1111DCBA1111DCBA

Acquisition Tracking: Streams

What metrics are important?


  • Stream Stories Posted
  • Stream Stories Clicked
  • Stream Installs

Acquisition Tracking: Streams

What API calls do I instrument to capture the metrics above?


Data Collection API Call Required Parameters Optional Parameters1 Where
psts, u, tu='stream'st1, st2, st3 Stream Post
psru, tu='stream', i2r, st1, st2, st3 Stream Post Click
apau, s None Stream Post Install

1 Any optional parameters sent from the original pst message must be sent in the pst message exactly the same.

2 The i parameter should be set to 0, to indicate that the user clicking the stream post has not installed the application.

Acquisition Tracking: Streams

Workflow Example


  1. During app usage, users are presented with the chance to post updates to their wall based on an event in the app. At the time when the user posts an update to their wall from within the app, the app sends the pst API call to Upsight Analytics.

  2. If one of the users' friends clicks on the post link and arrives on the app permissions landing page, the app sends the psr API call to Upsight Analytics, along with the same u parameter that was present in the pst API call. Do not wait until an install has occurred to send the psr API call.

  3. If the user then installs the application, the app sends the apa call with the sameu parameter that was in both the pst and psr calls. Proper attribution of install and virality metrics will only be tracked if the u parameter is the same across all three messages: pst, psr and apa.

Acquisition Tracking: Streams

Example Call


pst

s=1234567&u=ABCDEEEEABCDEEEE&tu=stream&st1=levelup&st2=share

psr

i=0&u=ABCDEEEEABCDEEEE&tu=stream&st1=levelup&st2=share

apa

s=100000987&u=ABCDEEEEABCDEEEE

Acquisition Tracking: Traffic

What metrics are important?


  • Ad Clicks and Installs
  • Cohort Metrics

Acquisition Tracking: Traffic

What API calls do I instrument to capture the metrics above?


Data Collection API Call Required Parameters Optional Parameters Where
uccsu, tu='ad' or tu='partner', i1st1, st2, st3 Detect on landing pages if from an undirected communication source click
apasu, s None Install from undirected communication source click

1 The i parameter should be set to 0, to indicate that the user has not already installed the application.

Acquisition Tracking: Traffic

Workflow Example


When you buy ads (regardless of the provider) or want to track user acquisition from a partner link (i.e. any arrangement like a cross promotion or links within other apps or you pay on a CPM basis instead of a CPC basis), the parameters below will need to be added to your ad links:

  1. As soon as a user clicks on your ad/link and comes to your landing page (this is typically the permissions page of your app), the link URL will have these 4 parameters:
    • kt_type: The value of this parameter must be ad or partner. You use ad for when you have CPC type agreements, and partner for when you have cross promotion or links within other apps, or if you have a CPM type of arrangement.
    • st1: This is the Campaign Name, which usually is denoted by the Ad/Partner's name.
    • st2: This is the Category, usually denoting the target demographic. For example: US_SanFrancisco_18-25.
    • st3: This is the Content of the ad. The st3 parameter enables you to differentiate between ad content shown. For example: Banner A, Banner B, Banner C.
  2. You will need to take the above four parameters from the link URL, and include the values in the st1, st2, st3 and tu (kt_type) parameters of the ucc API call, in addition to the other required parameters. The su parameter is a unique short tracking code that your system creates every time you send a ucc API call. Please note that you send the ucc API call to Upsight when the user lands on the landing page. Do not wait until an install occurs to send a this call.
  3. If the user continues to install the application, you must include the same short tracking code in the su paramater of the apa API call. This way we can ensure that the install is attributed to the ad that brought the user to your application. If the su parameter is not included in the apa API call, Upsight will not be able to attribute the install to the appropriate source.

Monetization Tracking

What metrics are important?


  • Revenue Total
  • ARPU
  • ARPPU
  • % Paying Users

Monetization Tracking

What API calls do I instrument to capture the metrics above?


Data Collection API Call Required Parameters Optional Parameters Where
mtus, v1tu2, st1, st2, st3 Revenue transaction

1 The v parameter must be set in cents, and can be either a positive or negative number. For example, a transaction of $1.25 should be set as v = 125.

2 The parameter tu is required if st1 is used. The possible values for tu are direct, indirect, advertisement, credits, or other.