Lexicon is a data dictionary that describes the data you are sending to Mixpanel. Mixpanel supports exporting a project's existing Lexicon data dictionary and importing data dictionaries into Lexicon.
Export Lexicon Data
Project owners, admins, analysts, and consumers can click Export in Lexicon to receive a CSV file via email that contains the events and properties, and/or user profile properties data from a project.
In the Export panel, you can select:
- Events & Properties; and/or
- User Profile Properties
The requester will receive an email with a link to download a single CSV file. This link remains active for 14 days.
The exported CSV file will contain the following columns:
- Entity Name
- Event Display Name
- Event Description
- Event Volume (30 Days)
- Event Query Volume (30 Days)
- Event Tags
- Event Hidden
- Event Dropped
- Property Name
- Property Display Name
- Property Description
- Property Volume (30 Days)
- Property Query Volume (30 Days)
- Property Type
- Property Example Values
- Property Hidden
- Property Dropped
- Property Required
- Property Sensitive
The following CSV snippet shows an example of the rows representing Events and Properties:
Each CSV file can contain up to 5,000 events, and 2,000 properties per event.
The following CSV snippet shows an example of the rows representing User Profile Properties:
Each CSV file can contain up to 2,000 user profile properties
Import Lexicon Data
Mixpanel supports multiple integrations (Avo.app, mParticle Data Plans, Segment Protocols) and methods (CSV import, Lexicon Schemas API) to import data dictionaries into Lexicon. Project Owner and Admin roles are required to import into Lexicon.
Event and property descriptions and metadata (hidden, dropped, sensitive, etc) that are already in Lexicon will be overwritten by descriptions and metadata for matching event and property names. By default, any event and property descriptions for events that are not imported will remain unchanged unless you check the option to overwrite your entire data dictionary during import.
In order to import your data dictionary from Avo.app, you will need to enable an integration with Mixpanel. The following information would be necessary in order to complete this integration from Avo.app:
- Mixpanel Project ID (
https://mixpanel.com/report/<Mixpanel Project ID>/...)
- Mixpanel Service Account Username & Secret (Owner or Admin role required)
To publish your Avo data dictionary to Lexicon, click the "Publish to Lexicon" button in the integration interface.
When importing a data dictionary from mParticle, navigate to your Data Plan and select Download Plan Version from the upper right menu.
- Click Import on the top right hand side of Lexicon
- Select mParticle
- Select the downloaded JSON file from mParticle Data Plans
- Review Events, Event Properties, and User Profile Properties to be imported.
- Import data into Lexicon
When importing a data dictionary from Segment Protocols using the Segment Config API, you will be asked for your Segment Token and Segment Workspace. You can find your Segment Token by going to your Segment dashboard:
Settings > Access Management > Tokens
You can use an existing Token, or creating a new token with a Token Role of Workspace Owner.
For the Segment Workplace value, we recommend using the Slug name located in the Segment dashboard:
Settings > General Settings.
Once you have your Segment Token & Workspace, head over to Lexicon and Select Import from Segment.
- Enter your Token & Workspace
- Select the Plan you want to import from Segment
- Review the Events and Profile Properties that will be imported
- Import your Segment Plan into Lexicon
Project owners and admins can export a CSV of their Lexicon changes, make changes, and import that CSV back into Lexicon.
When you export your Lexicon Data into a CSV file, you can make modifications, add events and/or properties, and import them into Lexicon.
To import CSV files, they must be in the exported CSV format, otherwise the file will be rejected:
Once you've made your modifications, you can directly import the CSV file into Lexicon:
- Select your CSV file
- Review Events, Event Properties, and/or User Profile Properties
- Import into Lexicon
Replacing Lexicon Entries
For mParticle, Segment, and CSV imports into Lexicon, you'll have an option to Replace Lexicon Entries.
If this option is enabled, all of your existing Lexicon entries would be removed and replaced by the uploaded entries. This feature is useful if you want Lexicon to contain only these new entries.
Lexicon Schemas API
Mixpanel provides a suite of API endpoints for you to Retrieve, Create, and Delete your data dictionary in Lexicon. To use these APIs, check out our developer docs.