Derived properties

You may want to run analyses based on properties that weren't sent to Amplitude. Amplitude Data’s derived properties allow you to create new event and user properties retroactively, based on functions and operators that you can apply across multiple existing properties. These don't affect your raw data and Amplitude computes them on the fly.

For example, you may want to create a chart that groups by whether an item added to a shopping cart is eligible for a discount. In that case, you could create a derived property whose value is a boolean based on whether the price exceeds a certain amount.

Feature availability

This feature is available to users on Enterprise plans only. See the pricing page for more details.

Create a derived property

To create a derived property, follow these steps:

1. In Amplitude Data, navigate to Tracking Plan—>Properties and click the Derived Properties tab.
2. Click + Add Derived Property.
3. Give your derived property a name.
4. Add any relevant metadata to your property, including a description (optional, unless you want to use the Suggest feature) and the visibility of the property in charts within this project.
5. Enter your formula. See below for the list of valid functions and operators.
6. Click Save.

Preview your results

As long as the formula you entered is valid, you can test the results in the space below the formula editor. Do this by selecting existing values for properties used in the formula, or test out any free-form values. You can do this from either the Create/Edit modal or from the side panel for a saved derived property.

Derived property use cases

Taking our previous referrer URL example, you can write a formula using string operators that looks like this:

SPLIT(PROPERTY('referrer_url','event'), "/", 2)

This formula converts a value like "https://www.google.com/search?q=amplitude" into the value "www.google.com." But what if you want to strip this down even further, to just "google"? You can achieve this by wrapping the result of a SPLIT function inside another SPLIT function. The resulting formula would look like this:

SPLIT(SPLIT(PROPERTY('referrer_url','event'), "/", 2), ".", 1)

Amplitude also supports math operators. Let’s say you have events that contain subtotal and tip properties, and you want to run some analyses based on the total amount. You can use this formula:

SUM(PROPERTY('subtotal','event'), PROPERTY('tip','event'))

Maybe you're also interested in knowing how many orders you would have given discounts to if the total order size was over $50. This formula tells you whether a particular order would receive a discount:

IF(SUM(PROPERTY('subtotal','event'), PROPERTY('tip','event')) >= 50, 'true')

Functions and operators

String functions

Math functions

Object functions

Date/ time functions

Amplitude requires all Unix timestamps to be in milliseconds.

Array functions

When performing computations on derived properties created from array properties, Amplitude assumes that only the first child is an array property, and only considers the first value of the other children, even if they're also array properties. 

Here are some illustrative examples:

1Example 1
2 propA = [1,2,3], propB = [a,b,c]
3 CONCAT(propA, propB) = [1a, 2a, 3a]
4Example 2
5 propA = [1, 2, 3], propB = [a]
6 CONCAT(propA, propB) = [1a, 2a, 3a]
7Example 3
8 propA = [1], propB = [a, b, c]
9 CONCAT(propA, propB) = [1a]

Property functions

When you select a property from the Insert Property dropdown, Amplitude inserts a property function referencing it directly into the editor for you. You can also manually insert this function wherever you want to reference a different Amplitude property.

These functions can only be used within another function.

Conditional operators

String/numerical operators

Set operators

Set literals ("apple", "orange") must appear on the right hand side of the operator.

Common derived properties formulas

This section provides a description of several common use cases for derived properties formulas.

Calculate the age of a customer

1CEIL(
2    DIVIDE(
3        MINUS(
4            PROPERTY('server_upload_time', 'amplitude_user'),
5            TIME_TO_LONG(PROPERTY('Created At', 'user'))
6        ),
7        86400000
8    )
9)

Use this when tracking a user property with a date-time data type, and you want to calculate the age of that user (in other words, how long that user has existed in your system) since the time of the event that triggered when this user property was set.

Get the difference between two dates

 1DIVIDE(
 2  SUBTRACTION(
 3  DATE_TO_LONG(
 4  PROPERTY(
 5  'Subscription Start Date', 'user'
 6  )
 7  ),
 8  DATE_TO_LONG(
 9  PROPERTY(
10  'Subscription End Date', 'user'
11  )
12  )
13  ),
14  86400000
15)

Sample output:

In the derived property above, the properties end_date and start_date are converted into UNIX timestamps, so that Amplitude can calculate the difference between them. That result is then divided by 86400000, which is the number of milliseconds in one day.

Output a standardized date format

 1IF(
 2    DATE_TIME_FORMATTER(
 3        PROPERTY(
 4            'publishDate',
 5            'event'
 6        ),
 7        "yyyy-MM-dd'T'HH:mm:ssX",
 8        'yyyy-MM-dd'
 9    )
10    contains '-',
11    DATE_TIME_FORMATTER(
12        PROPERTY(
13            'publishDate',
14            'event'
15        ),
16        "yyyy-MM-dd'T'HH:mm:ssX",
17        'yyyy-MM-dd'
18    ),
19    IF(
20        DATE_TIME_FORMATTER(
21            PROPERTY(
22                'publishDate',
23                'event'
24            ),
25            "yyyy-MM-dd HH:mm:ss",
26            'yyyy-MM-dd'
27        )
28        contains '-',
29        DATE_TIME_FORMATTER(
30            PROPERTY(
31                'publishDate',
32                'event'
33            ),
34            "yyyy-MM-dd HH:mm:ss",
35            'yyyy-MM-dd'
36        ),
37        DATE_TIME_FORMATTER(
38            PROPERTY(
39                'publishDate',
40                'event'
41            ),
42            "yyyy-MM-dd",
43            'yyyy-MM-dd'
44        )
45    )
46)
47IF(
48    DATE_TIME_FORMATTER(
49        $60,
50        "yyyy-MM-dd'T'HH:mm:ssX",
51        'yyyy-MM-dd'
52    )
53    contains '-',
54    DATE_TIME_FORMATTER(
55        $61,
56        "yyyy-MM-dd'T'HH:mm:ssX",
57        'yyyy-MM-dd'
58    ),
59    IF(
60        DATE_TIME_FORMATTER(
61            $72,
62            "yyyy-MM-dd HH:mm:ss",
63            'yyyy-MM-dd'
64        ) contains '-',
65        DATE_TIME_FORMATTER(
66            $73 ,
67            "yyyy-MM-dd HH:mm:ss",
68            'yyyy-MM-dd'
69        ),
70        DATE_TIME_FORMATTER(
71            $76 ,
72            "yyyy-MM-dd",
73            'yyyy-MM-dd'
74        )
75    )
76)

Sample output:

One way to format dates to Standard Date Format is to use a series of IF statements. Make sure the higher specificity conditional comes first. Replace the $<number> here with the actual properties.

Get the month and year a customer signed up

1CONCAT(
2    REGEXEXTRACT(
3        PROPERTY(
4            'Subscription Start Date',
5            'user'
6        ),
7        'dddd-dd'
8    ), "-01"
9)

In this example, the derived property pulls the sign-up month and year from a property that contains a more detailed value, and append the "-01" to set it to the beginning of the month. Use the REGEXEXTRACT() to pull the year and month from the value, and use CONCAT() to append the "-01". Replace the $<number> here with the actual properties.

Replace existing property values

 1IF(
 2    OR(
 3        REGEXEXTRACT(
 4            PROPERTY(
 5                "package",
 6                "event"
 7                ),
 8            'Casual'
 9        ) =='Casual',
10        REGEXEXTRACT(
11            PROPERTY(
12                "package",
13                "event"
14            ),
15            '1 Job Posting'
16        )=='1 Job Posting',
17        REGEXEXTRACT(
18            PROPERTY(
19                "package",
20                "event"
21            ),
22            '1 Basic'
23        )=='1 Basic'
24    ),
25    'Casual',
26    'False'
27)

Sample output:

To replace multiple property values, use REGEXEXTRACT() to pull the string in the property, and use OR statements inside an IF statement to see if the value pulled from the properties contains any of the values you wish to replace. In this example, if the property value matches any of the values specified, it replaces the value with Casual. Otherwise, it replaces the property with False. Replace the $<number> here with the actual properties.

Count length of an array that was accidentally ingested as a string

Convert the string to an array format by using SPLIT:

1SPLIT(
2PROPERTY('color', 'event'),
3','
4)

Sample output:

The property color was ingested as a string into Amplitude "Red, Green, Blue". After using SPLIT, the resulting value is [Red, Green, Blue].

Use the above derived property within a new derived property that uses ITEM_COUNT.

1ITEM_COUNT(
2PROPERTY("Transform into Array", "derived")
3)

Sample output:

Now the underlying data being used is an array. ITEM_COUNT counts the number of items that make up the array.