Add Custom Metadata Fields

Last updated:

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

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

Download a CSV of visitors

To download a CSV file of your visitors, navigate to Analytics > Visitors, and select the Download CSV  Screen_Shot_2021-10-11_at_5.13.30_PM.png icon in the top-right corner of the Visitors table. This download includes "auto" metadata from the agent, such as last-used browser, user agent, and so on.

Upload a CSV file

Upload a CSV file to apply your provided metadata to their visitors. This upload creates new visitors if they don't yet exist and existing metadata fields are 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, for example, sfdcprofile

Example CSV file

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

Tips for Uploading CSV file containing metadata

  1. You can't 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:

    2. Example:

    3. Example:

Note: On the Upload CSV page, you can't upload a CSV file with non-custom metadata header that already exists ( or This will impact the performance of your Adopt subscription. 

Add custom metadata fields

Custom metadata fields are added in Settings > Metadata at the bottom of the page. The last row has a purple Custom label and an option to Add Custom Field. Name your metadata field and select its type from the dropdown.

Note: Once a character has been inputed into the Add Custom Field section, you can add it to the existing metadata fields. 2021-10-05_10-21-39__1_.gif

Remove agent or custom metadata

Agent or Custom metadata can be removed or deleted from the Metadata tab. To delete a metadata field, hover over the relevant row, select Remove at the end of the row, and then confirm the deletion.


Available data types

There are currently six data types available in Adopt. The data that you send must match the correct format for the data type that you are mapping it to. The table below outlines each data type and provides an example of data that matches that type. 

Data Type Description Example
Text This is the most basic data type in Pendo and is intended for any fields that should be represented as simple text within Pendo.

Email Address

Boolean This data type is used when setting a value to either true or false.

Admin User

  isAdmin: true,
Number (int) This data type is for any whole number.

Dashboard Count

dashboardCount: 3,
Number (float) This data type is for any number that includes a decimal.

Percent Storage Used

percentStorageUsed: .776,
Date This data type is used for any date that you will be passing to Pendo. Pendo uses the ISO8601 W3C format. 

Subscription Start

subscriptionStart: "2006-01-02T15:04:05.999-05:00",
List This data type is used for any metadata field that may need to contain more than one value. This data type is only available for agent metadata. Roles
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. Examples include Role, Department, and Title.