Application Overview

What is Application Overview?


The Upsight Dashboard lets you add and delete apps, edit their basic information, and add any resources they need. Specifically, you can add milestones, rewards, in-app purchases, and specify the different versions of the app that have been released.

How to Access Settings


Once you are logged in, at the bottom left of the Upsight Dashboard are settings links. Click APPLICATIONS to see a list of your apps.

Settings

How to Add an App


  1. Click ADD AN APP to add your app to Upsight. You can specify if your app is already on the App Store or Google Play store.

    App list

    If your iOS app is not released yet, just enter its title. If it is live on the App Store, select a region and find your app in the APPLICATION NAME drop-down menu.

    iOS App add

    If your Android app is not released yet, just enter its name and click CREATE APP. If it is on the Google Play store, enter its Google Play Bundle ID instead.

    Android App add

  2. For either iOS or Android apps, the next screen will show the App Token and Public Key you’ll need for integrating our SDKs.

    Token and Public Key

How to Edit an App


  1. Once you’ve added your app, you will go back to the app list page. From there, you can click EDIT in the dropdown next to the app’s name to go to that app’s settings.

  2. In GENERAL SETTINGS, you can edit your app’s nickname, and see information like the app’s ID, token, public key, and current status:

    General Settings

Opt-in Data Collection


What is Opt-in Data Collection?

Gather valuable data to engage with your users outside of your app! Ever want to know the average age or gender of your user base? How about their email address or phone number? With Upsight's Opt-In Data Campaigns gathering this data is as easy as following a handful of steps from our web based dashboard. Easily download this data from a secure and private section of your Dashboard and manage your user base accordingly!

Opt-in Data Use Cases

If they love your app, it's not spam!

Below are some examples of how to use Opt-In Data Collection.

  • Weekly Newsletters - Use your email list to keep your users informed of not only the app they are using, but expose them to the other awesome things happening at your company.

  • App Update Announcements - Email your user base to let them know about your newest update and get them back in the app!

  • New App Cross-Promotions - Get the word out about your newest title to your existing user base.

  • Surveys - Target your most loyal users and follow up with a survey. Ask them what they really think about your app or what they would like to see in it's sequel! (i.e. "You are one of our most loyal users and we want to know what you think!)

  • Promotional Contests/Drawings - Set up a contest for your user base and ask them to opt-in to a drawing (i.e. "Submit your email address for a chance to win 100,000 gold coins! Drawing ends this Friday!").

  • SMS Marketing - You can directly communicate via SMS outside the confines of Apple/Google push notification policies. Unique to SMS, users read these messages on the device giving publishers the ability to directly link to the App Store or app itself using URL handlers.

How to Create an Opt-in Data Campaign

To create an Opt-in Data collection campaign, see our documentation on Campaign Builder.

How to Export Data

  1. To export your Opt-in Data collection navigate to APPLICATIONS > APP NAME > APP SETTINGS > OPT-IN DATA COLLECTION.

  2. Select the Opt-in Data campaign you want to export data from.

  3. Select the time duration of the campaign you want to export data from.

  4. Click DOWNLOAD CSV to download data as a CSV.

Private Policy

The Upsight Privacy Policy is included as a link within the content unit. Users can view the Privacy Policy within the content unit without leaving the app. As with most policies from companies that reside in the U.S., this is written in accordance to U.S. laws (e.g. COPPA compliance) and is not intended to specifically address foreign laws.

Security

All data submitted is sent through an encrypted transmission via SSL to protect user privacy. Upsight will not use your collected data. The data collected is your own and for you to use how you see fit.

Milestones


What are Milestones?

Milestones are a new way to track user movement through your app and allow you to manage exactly when and where a user sees content. Milestones are triggered when your user reaches a point in your application that you want to track or take action on.

How to create a Milestone

  1. To create a Milestone navigate to APPLICATIONS > APP NAME > APP SETTINGS > MILESTONES > ADD MILESTONE.

  2. In the SCOPE textbox, enter a description of the user location or action within the app. Ensure the scope matches what is used within your app. Scope is limited to lowercases and no spaces. Examples of Scope include “level_up”, “app_launch”, “share_article”.

  3. In the DESCRIPTION text enter a more detailed description of your scope.

Milestones

Note Milestones require additional instrumentation to function properly, please see your platform's respective integration guide (iOS, Android) for more information on the steps required to implement milestones in your application.

Rewards

Overview


What are Rewards?

Rewards are items you define that are given to your users using the Reward Campaigns. Any creative can contain a reward for your user.

In order to set up a reward, first add Reward items to your app settings in the dashboard before creating a Reward Campaign.

Important Please note that the Reward item that you define on the Upsight dashboard will be converted to lower case and can only contain alphanumeric characters and underscores.

Reward Use Cases

  • Improve Retention with Daily or Weekly Login Rewards

  • Create Regional Specific Item Promotions

  • Reengage Inactive Users

  • Establish Better Relationships with Top Users

How to add a Reward

  1. To add a Reward, navigate to APPLICATIONS > APP NAME > APP SETTINGS > REWARDS > ADD REWARD.

  2. In the TAG textbox, enter the name you would like to use for your reward item.

    Note This should be a unique string that represents unlockable content in your app and must be recognized within your app code.

  3. In the DESCRIPTION textbox, enter a more detailed description of your reward.

  4. For SUPPORTED APP VERSIONS, select the min and max versions that the reward is supported for your app.

  5. Then click SAVE to add the Reward to the dashboard.

Note Reward campaigns require additional instrumentation to function properly, please see your platform's respective integration guide (iOS, Android) for more information on the steps required to implement rewards in your application.

Rewards

Server-Side Reward Granting


Campaigns in Upsight that grant users rewards can have the reward be granted either client-side, via the SDK, or server-side. Server-Side reward granting allows Upsight to directly contact your server with the information on which users have been granted which rewards.

To configure Server-Side reward granting, click on the Configure Server-to-Server Callback link from within the Rewards section of the Application's settings.

Within the configuration page, there will be two fields to complete:

  • The Callback URL
  • The Private Key

Callback URL

The Callback URL is the address of your server that Upsight will make an HTTP request to to inform you that a user has received an award. There are various macros available that will be replaced with the values for the specific user and reward being granted. These are:

  • app_token - This is the Application's Public Token. You can use this if you plan to have a single URL to accept callbacks from multiple applications to identify which application the reward is being granted from.
  • sid - This is the user's Unique Upsight ID
  • idfv - This is the user's Unique Vendor ID for Apple and Google
  • reward - This is the ID of the reward granted to the user
  • quantity - This is the quantity of the reward item granted to the user
  • unique_id - This is a unique ID for the specific transaction granting the user the reward, so that you can ensure that each reward is only granted once

To construct your Callback URL, enter your hostname and path, followed by the parameters and macros you wish to receive, for example:

https://www.mysite.com/games/rewards/grant?app={app_token}&user={sid}&reward={reward}&quantity={quantity}&transaction_id={unique_id}

Note that the URL parameters may be named according to what your server expects and do not need to be exactly the same as the macro names.

Private Key

The Private Key is a key of your choice which will be used to sign the request that Upsight makes to your server, so you can verify that the request was made legitimately by Upsight and not by any other party that may have discovered your reward URL.

For more information on the signing and verification process, see our documentation here.

Testing

Once you have entered the Callback URL and Private Key, you can test that the Callback is working. You may enter values for the macros, or have random values generated for the various ID fields.

The Preview button will show an example of the completed URL that will be called, as well as what the Authorization header will look like. You may use these in your verification without Upsight making a call to your server. Once you have completed your implementation, the Test button will make a live call with the entered information. You may wish to use a specific sid or unique_id in your testing so you may prevent rewards from being granted to real users.

The test is considered successful when we receive an HTTP 200 response.

Once the test is successful, you may save the Callback in an enabled state. If you are unable to complete a successful test, but which to save your progress, use the toggle at the top of the page to set the callback to a disabled state before saving.

Segments


What are Segments?

Not all users are the same yet they often all receive the same experience. Is a user that's never spent money in an app likely to make a $99.99 transaction for their first purchase? Should a user in China encounter a 4th of July-themed promotion? Can a non-English speaking player read English? The answer's no.

Displaying the same content for all users leads to lost opportunity ("no way I'm paying $99.99 for this but I'd buy that for $1.99), worse user experience ("I can't read English!"), and may even turn off users ("They recognize the U.S.'s Independence Day but not the Chinese New Year!?"). Optimizing the content shown to users based on their context (e.g. location, hardware, language) and behavior (e.g. purchase history, time in-app, number of sessions) is critical to maximizing LTV.

These problems are solved by Segments which allow you to target specific users for your app based on predefined and custom attributes that you define. Segments allows for complex targeting rules using one or many attributes. Each Segment can be defined with Boolean Operators (AND/OR) and nested rules.

Note Test Devices do not adhere to targeting rules.

How to Create a Segment

To create a segment, you can use:

or

  1. Navigate to APPLICATIONS > APP NAME > APP SETTINGS > SEGMENTS > ADD SEGMENT.

  2. In the NEW SEGMENT textbox, enter a description of your segment.

  3. In the SEGMENT DESCRIPTION textbox, enter a more detailed description of your segment.

  4. Add all Segmentation targeting rules using one or many attributes with boolean operators and nested rules.

  5. Then click SAVE to add the Segment to the dashboard.

App Versions


What are app versions?

App versions are specific releases of your application. By adding app versions to your app settings in the dashboard, you will be able to target users on those versions when delivering content to them.

How to add an app version

  1. Navigate to APPLICATIONS > APP NAME > APP SETTINGS > APP VERSIONS > ADD APP VERSION.

  2. In the VERSION textbox, enter the app version defined in your code.

  3. In the DESCRIPTION textbox, enter a description describing the app version and changes from prior app versions.

  4. Then click SAVE to add an app version to the dashboard.

In App Purchases


What are In-App Purchases?

In-App Purchase (IAP) Products let you sell a variety of items directly within your app, including app currency, virtual goods, or other in-app content.

IAP Products are configured in iTunes Connect or Google Play, for their respective platforms, and added to the Dashboard. IAP Products are selected when creating a Virtual Good Promotion campaign.

Virtual Good Promotion Campaign Use Cases

Promote any in-app item at the right time to the right audience and:

  • Maximize your in-app revenue

  • Turn non-paying users into purchasers

  • Establish a better relationship with whales

  • Increase awareness of and engagement with your virtual goods

There's no need to guess at what pricing might work for your in-app purchases. Real-time testing of everything - from where to put a promotion in your app to pricing - gives you the flexibility to make the most informed decisions for maximizing user value.

If the Upsight servers are made aware that a given user has already purchased a non-consumable In-App Purchase item, it will not show Virtual Goods Promotion Content Units for that item to that user. This is to avoid showing the user a promotion for an item that they have already purchased.

How to add an In-App Purchase Product

  1. Navigate to APPLICATIONS > APP NAME > APP SETTINGS > IAP > ADD IAP PRODUCT.

  2. In the PRODUCT ID textbox, enter your Product ID from iTunes Connect or Google Play.

  3. In the DESCRIPTION textbox, enter a meaningful description for your IAP Product.

  4. From the TYPE radio boxes, select whether your IAP is consumable or non-consumable.

    Note This must match what you have defined in iTunes Connect or Google Play.

    • Consumable IAP Products such as virtual currency, can be purchased an infinite number of times by a particular player.
    • Non-consumable IAP Products will be awarded to end users only if they do not already own it. Non-consumable items such as a sword, can only be purchased once.
  5. In the PRICE TIER dropdown, select your IAP price tier.

    Note The selected Price Tier for this IAP Product must match what's defined in iTunes Connect or Google Play. The user will always be charged the iTunes Connect or Google Play price tier regardless of what is selected in the Upsight Marketing Dashboard.

  6. From the CLEARED FOR SALE radio boxes, indicate if the item is cleared for sale or not.

    Note This must match what's defined in iTunes Connect or Google Play.

  7. For SUPPORTED APP VERSIONS, select the min and max versions that the IAP product is supported for your app.

  8. Then click SAVE to add the In-App product to the dashboard.

Note Virtual Good Promotion campaigns require additional instrumentation to function properly, please see your platform's respective integration guide (iOS, Android) for more information on the steps required to implement virtual good promotions in your application.

How to track Revenue and add Receipt Verification

To track revenue and add receipt verification, please see your platform's respective integration guide (iOS, Android).

For Android, upload your Google Play Credentials in your application settings under SETTINGS > APPLICATIONS > EDIT APP > UPLOAD GOOGLE PLAY CREDENTIALS.

How to create Google Play Credentials for IAP Receipt Verification

  1. To obtain Google Play Credentials, you will need to sign into your Google Play Developer's Console.

    Note Ensure you are the main administrator to this account.

  2. Go to SETTINGS > API ACCESS to link a Google Developer project to this account.

  3. Select your existing project or choose CREATE NEW PROJECT if you do not have an existing project.
  4. On the APIS & AUTH > CREDENTIALS page, click CREATE NEW CLIENT ID under OAuth.
  5. Select CREATE SERVICE ACCOUNT and click CREATE CLIENT ID. A JSON key will then automatically download.
  6. If a JSON key does not automatically download, click GENERATE NEW JSON KEY.
  7. Now navigate back to your google play store's publisher account. Your newly generated user will appear here under service accounts.
  8. Click GRANT ACCESS and grant READ ONLY access to the newly created user.
  9. Finally, upload the JSON key that you just downloaded in your application settings by going to SETTINGS > APPLICATIONS > EDIT APP > UPLOAD GOOGLE PLAY CREDENTIALS.

Custom Attributes

What are Custom Attributes?


The Upsight platform provides you the ability to interactively segment your users through User Explorer and create powerful marketing campaigns using these segments. By default you can target by a number of key attributes, but there are many times when you may wish to segment based on your own specific needs and criteria.

This is what Custom Attributes allows you to do. You can send data either through CSV upload or the Upsight SDK to attach any unique value to each user and all their events. A couple powerful use-cases of Custom Attributes include:

  • Attribution Source

    If you keep track of what acquisition source you might want to target users by channel. For example, if you want to test out a new ad network you could buy a test set of installs and then target them with special campaigns within Upsight.

  • Targeting Churn Prone Users

    After identifying users who may be churn prone you can send them push messages with Rewards, Virtual Good Promotions, or Announcements encouraging them to re-engage with your app.

  • Cross Promotions

    If you have a number of apps you may want to promote apps to users who don't have them installed. For example, if you have apps A, B, and C you may want to segment users in app A who don't have app B installed and promote app B, and for those who don't have app C installed promote app C.

There are many use cases for custom attributes so please use your creativity, and feel free to reach out with any questions or unique scenarios.

Custom Attributes

How do I create a Custom Attribute


To create a custom attribute:

  1. Log into your dashboard and navigate to SETTINGS > APPLICATIONS > "YOUR APP" > APP SETTINGS > CUSTOM ATTRIBUTES.

  2. On the top of the screen, click the ADD CUSTOM ATTRIBUTE button.

    Custom Attributes

    Important Once you have added a custom attribute you cannot edit it, so please be careful!

  3. In the ATTRIBUTE VARIABLE NAME textbox, enter the name you would like your Custom Attribute to have.

    Attribute Name

    Note This is a key to your variable for use in the CSV uploader or SDK. This value can be comprised of letters, digits, or _, and cannot have spaces or other special characters. Examples include user_level or acquisition_channel.

  4. In the ATTRIBUTE DESCRIPTION textbox, enter a meaningful description of your Custom Attribute.

    Attribute Description

  5. From the ATTRIBUTE TYPE dropdown menu, select the variable type you would like your Custom Attribute to have.

    The three available types are:

    • Number: Useful for storing a user level or any numeric data (numbers can be integers or decimals). Numeric dimensions support matching operations of equals (user_level = 10, for example) or a range (user_level is between 5 and 20, for example).​

    • String: Useful for storing text data, this data can be matched by is or is not (example: acquisition_channel is Upsight).

    • Boolean: Useful for storing true or false data, can match is true or is false (example: is_churn_prone is true).

    Attribute Type

  6. On the bottom of the screen, click the SAVE button to save your Custom Attribute.

Custom Attributes

How to Upload Data using CSV


If you want to upload files with your custom attribute data manually you can do so using the Upsight dashboard.

To upload a file:

  1. Log into your dashboard and navigate to SETTINGS > APPLICATIONS > "YOUR APP" > APP SETTINGS > CUSTOM ATTRIBUTES.

  2. Select the Custom Attribute you want to upload values for and click UPLOAD VALUES.

How to set Data

Format

To use the CSV uploader in the dashboard to set custom attribute data, use the following format:

device_id,type_id,attribute_name
  • device_id is the IFA, IDFV, or Android ID of the device you'd like to store the attribute for.

  • type_id: One of ifa, idfv or device. IFA, and IDFV are for iOS, and DEVICE are for Android.

  • attribute_name: The name of your custom attribute. For example, user_level or virtual_currency.​

Example:

device_id,type_id,user_level
28033E33-DFB6-42D1-BCA9-E7E693669F4D,ifa,10
73BD7A17-A3B3-427A-91CF-8E27B41A6B8C,idfv,15

Valid Values

  • String - A string of text, up to n characters.
  • Number - A number for comparison, can be an integer or decimal.
  • Boolean - True will be set to true, everything else will be set to false.

How to delete a value

To delete a value for a Custom Attribute, include it in an upload with a missing value. For example, this file will result in a user_level of 2.5 being set for IDFA 28033E33-DFB6-42D1-BCA9-E7E693669F4D, and user_level will be deleted for 73BD7A17-A3B3-427A-91CF-8E27B41A6B8C.

device_id,type_id,user_level
28033E33-DFB6-42D1-BCA9-E7E693669F4D,ifa,2.5
73BD7A17-A3B3-427A-91CF-8E27B41A6B8C,ifa,

Custom Attributes

How to send Custom Attributes with SDK


For instructions on sending Custom Attributes via the SDK, please see our SDK documentation for iOS and Android.