Add Custom Metadata Fields

Warning: After adding a custom metadata field, add at least one additional subfield. 

Overview

The Metadata tab on the Settings page allows you to view the metadata keys associated with agent-provided metadata and custom metadata. You will need these metadata keys to properly prepare your CSV file for upload. The Metadata tab on the Settings page also enables you to create custom metadata fields.

Download CSV of Visitors

1. Go to Analytics (1) > Visitors (2). 

2. Click the "Download CSV"  button shown below.

Note: This download will include “auto” metadata from the agent, such as last used browser, user agent, etc.

Upload CSV File

This upload will apply your provided metadata to their visitors. Keep in mind that visitors that do not exist will be created through this upload and existing metadata fields will be overwritten with new values. 

Tip: If you are adding a custom metadata field such as SFDC_Profile, then the metadata key should be the field name, i.e. sfdcprofile. 

Example CSV file

Use this example csv file. Save a copy and use this file to populate your data. (You must be signed into a Google account to save a copy.) 

Tips for Uploading CSV file containing metadata

1. You cannot manually modify agent provided metadata via uploading a CSV file.

2. When preparing your Excel spreadsheet for upload, the first column needs to be visitorId i.e your employees email address. All additional column titles should correspond with their metadata key (you can set your Visitor ID to be something other than an email address, but email is recommended).

3. Boolean values are either true or false. CSV files are case sensitive, so double check that the value is lowercase as it might impact the metadata upload.

4. Visitor ID is case sensitive.

   1. Example: Generic.Name@Company.com

   2. Example: Generic.name@Company.com

   3. Example: Generic.name@Company.com

Note: On the Upload CSV page, you are not able to upload a CSV file with non-custom metadata header that already exists (i.e visitor.auto.xyz or visitor.agent.xyz). This will impact the performance of your Adopt subscription. 

Adding Custom Metadata Fields

1. Go to Settings > Metadata.

2. Scroll to the bottom. The last row has a purple "Custom" label (1) as well as the option to "Add Custom Field" (2). Name your metadata field and select its type from the dropdown (3). 

Note: Once a character has been inputed into the "Add Custom Field" (2) section, you can add it to the existing metadata fields.

Remove Agent Or Custom Metadata

Agent or Custom metadata can be removed or deleted from the Metadata tab. To delete a metadata field, click on Remove and confirm the deletion.

Available Data Types

There are currently 6 data types available in Adopt. It is important that the data that you are sending matches the correct formatting for the data type that you will be mapping it to. The table below outlines each data type and provides an example of data that matches that type. 

visitor:{
 id:62343,
 email:'john@doe.com',

visitor:{
  id:62343,
  isAdmin: true,

visitor:{
 id:62343,
 dashboardCount: 3,

visitor:{
 id:62343,
 percentStorageUsed: .776,

visitor:{
 id:62343,
 subscriptionStart: "2006-01-02T15:04:05.999-05:00",

 visitor:{
 id:62343,
 roles: ['admin', 'end-user', 'super-user'],

Frequently Asked Questions

What Types Of Metadata Should I Send To Pendo?

Send us anything you would find beneficial in segmenting your visitors. Several examples include Role, Department, Title etc.