Setup Custom Dimensions & Metrics

In this article:

Limits and caveats

1. Once a custom dimension or metric is created, you can only modify its name but not its type. Once the name is changed, you will need to start sending data with the new name and we'll update the name for all the old data.

2. Deletion of any custom dimensions or metrics is permanent and unrecoverable. Deleting a metric or dimension via the “Account Settings” page also deletes the data associated with that setting.

3. Value of custom dimensions and metrics will be stored as a "Double", allowing for fractional numbers.

4. There is a maximum number of characters (255 characters) allowed for string based dimensions. In other words, both the name and values of a specific dimension need to be within the maximum number of characters.

5. When naming the custom dimension and metric, each name needs to be globally unique.

6. When sending the custom dimension and metric, the name for the same dimension/metric needs to be consistent (exact match), otherwise it'll be captured as a separate custom dimension/metric. 

7. If the value of a custom metric and/or value dimension does not exist for an account, we'll set it to be zero for that account. For accounts that do not have value for a custom text dimension, you can filter these accounts in the List Explorer by constructing a condition that says "Name of custom text dimension" "Does not exist". 

8. Natero currently supports both custom dimensions and metrics for accounts but only custom dimensions for users. 

Setup custom dimensions and metrics

Custom Dimensions for Accounts

You have two options to setup a custom dimension for your accounts:

1. Using the bulk editing feature 

First you need to define your custom account dimensions with a name and type in the “Account Settings”, select "Edit custom dimensions/metrics" from the dropdown.

  • Name – The name of the custom dimension as it will appear in the Natero platform.
  • Type – Specify whether it is a textual dimension, numeric dimension or date-based dimension.

Once saved, they will appear as separate columns in the bulk editing spreadsheet for you to edit directly.

2. Using the Natero Account API to attach custom dimensions to accounts.

Note that when sending over the custom dimensions, use the below names for each type:

  • Textual: custom_label_dimensions
  • Numeric: custom_value_dimensions
  • Date-based: custom_event_dimensions

Custom Metrics for Accounts

While custom dimensions can be defined in your "Account Settings" and updated using the bulk editing feature within the Natero platform. Custom metrics need to be captured through the Natero Account API.

Since custom metrics are time series related, they need to be sent with timestamp information through the Natero Account API. The timestamp needs to be in epoch milliseconds (UTC timezone is assumed). You can also send custom dimensions from your implementation using the Natero Account API. 

Your data will then be processed using your custom dimension and metric definitions. We'll capture the names of the custom dimensions and metrics you send automatically in the "Account Settings" -> "Edit Custom Dimensions/Metrics" for your reference.

Custom Dimensions for Users

There are two options to setup a custom dimension for your users:

1. Using the “Contacts & Users” section in the Account Details page

First you need to define your custom user dimensions with a name and type in the “Account Settings”, select "Edit custom dimensions/metrics" from the dropdown.

  • Name – The name of the custom dimension as it will appear in the Natero platform.
  • Type – Specify whether it is a textual dimension or numeric dimension.

Then you can update custom dimension values at the Account Details, Contacts & Users page for each individual user. Please note that bulk editing for user details is currently not supported in Natero. 

2. Using the Natero Account API to attach custom dimensions to users using the "dimensions" object.

 
 

Learn more about reporting of the custom dimensions and metrics.

Have more questions? Submit a request

Comments