Custom tags

Note

Checkout Filters to know more about regular and advanced filters.

Clarity's custom tags are customizable filters, that allow you to analyze Recordings and Heatmaps in different directions. You can easily create custom tags and share it across your team. You can pass additional information through custom tags.

There are no limits on the number of tags you can add to your project.

Following are few scenarios where you can use custom tags, but not limited to:

  • Show recordings for specific user.
  • Record or analyze and search through custom fields.
  • Spot users by an ID, which is significant to your application database.
  • Rename userID to meaningful name thereby you can search through them easily.
  • Show recordings or heatmaps for flight or experiment IDs.

Where do custom tags show up?

You can create custom tags for Recordings, Heatmaps, and Dashboard. You can find custom tags under Filters section.

Custom tags for Heatmaps.

How to setup custom tags?

You can create your own filters by setting tags in your website code.

  • The tags can be any alphanumeric value you like including spaces, For example, 'Checkout Page'.
  • The tag and its value cannot be longer than 255 characters.
  • A single page can have no more than 128 tags. Any additional tags will be ignored.

Step 1

Identify the information you want to send to Clarity. This information should be a key value pair.

Key: The tag name that identifies the kind of information you are sending.

Value: The value attached to the tag.

Step 2

Add this code snippet into your website code:

clarity("set", key, "value");

Example:

To create custom tags to filter out recordings based on flight or experiment ID, the key can be flight and value can be testflight1.

Hence, the code snippet would be - clarity("set", flight, "testflight1");

Add custom tags to your project

As you add the tag in your website code, it will be updated in your project within 30 minutes to 2 hours. You can add multiple tags to a project.

Step 1

To start using the tag, select a project feature and go to 'Filters'. Select the tag under 'Custom tags'.

Select custom tags for Heatmaps.

Step 2

Select + icon to add the tag.

Add custom tags for Heatmaps.

Delete a custom tag

Step 1

Go to 'Custom tags' under 'Filters'.

Select custom tags to delete.

Step 2

Select 'Delete icon' next to the tag.

Delete custom tags.

Setup JavaScript triggers through Google Tag Manager

If you use Google Tag Manager to load the Clarity script on your site, you can set up JavaScript triggers that fire the Clarity tracking code.

In order to setup, review Google Tag Manager in third-party platform installation.

Check out this guide on how to set up JavaScript Triggers in Google Tag Manager.

FAQ

For more answers, refer to General FAQ.

How soon is the tag available on my project?

As you add a tag in your website code, it will be updated in your project within 30 minutes to 2 hours.

How many tags can I add to my website?

There are no limits on number of tags you can add to your website. However, a single page can have no more than 128 tags. Any additional tags will be ignored.

How to use custom tags to find out users who haven't used a feature?

Define the feature in custom tag and add the custom tag to your project to start using it.

Visit Clarity