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.

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.

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 Upload Data using CSV

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 Upload Data using CSV

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,

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.