This article will help you:
In the Settings page, you will:
Name your project, and specify the naming conventions you’ll use for events and properties
Specify whether you’ll require team reviews for all changes to main
Set the Amplitude projects for your environments
Generate API tokens
- Specify your schema settings
Delete your Amplitude Data project
These settings and features are broken out into four different tabs: General; Environments; Integrations; and API Tokens, each of which is described below.
NOTE: Make sure you’ve configured your settings before setting up your first Amplitude Data project.
Roles and permissions in Amplitude Data
|Admin||Configure workspace settings, approve tracking plan changes, and modify the tracking plan|
|Manager||Approve tracking plan changes and modify the tracking plan|
|Member||Modify the tracking plan for approval|
|Viewer||View the tracking plan and comment|
NOTE: If the Require team reviews to make changes to the main branch option is disabled in the project settings, members will have the ability to modify the tracking plan; however, receiving approval would no longer be required. All other permissions remain the same.
The General tab
The General tab is where you’ll give your project a name, set the event and property naming conventions, set team review requirements for making changes on main, and delete your project, should you wish to do so. It’s also where you’ll find a public link to a read-only version of your tracking plan, so you can easily and safely share it with stakeholders across your organization.
Amplitude Data requires you to set a consistent naming convention for events and properties. Without one, your tracking plan can become much harder to read and manage, as there could be multiple events / properties using the same name, but with different capitalization rules.
Choose from the following naming conventions:
Additionally, you can specify a custom naming convention, if you’d prefer.
For larger teams and organizations, it’s good practice to require team reviews for any changes made to main. When this option is selected, any changes to your tracking plan must be made in a branch other than main. You can specify the number of reviewers required for approval—up to seven—here as well.
Public link to your tracking plan
If you ever want to share your tracking plan, you can do so using the public link provided here on the General tab. Just copy it to your clipboard and paste it into an email or Slack message. Stakeholders can read it, but they can’t make any changes themselves.
The Environments tab
In Amplitude Data, the project is where you configure events, properties, sources, and destinations. It’s also called the tracking plan, and you can read about it here.
This is distinct from an environment, which we will get to in a moment.
Here’s where it can get confusing. Amplitude Analytics also uses projects, but it does so differently. Setting up a project in Amplitude Analytics is a prerequisite for receiving data from your product—the project is where the data flows to, and it’s where you conduct your analyses.
In fact, it’s best practice to have at least two projects in Amplitude Analytics: one for production, and one for development. This way, you can validate against the development project first, and then roll out approved changes to production.
In Amplitude Data, the environment is just another name for a specific project in Amplitude Analytics.
Each project in Amplitude Data can have up to two environments. Ideally, you’ll use one for debugging and the other for clean production data.
In Amplitude Data, the Environments tab is where you’ll manage the mapping between your two environments—production and development—and your Amplitude projects. Amplitude Data will use the information you enter here to configure sources and destinations, validate data in the tracking plan page, and schema syncing on the Integrations tab.
For each environment, select the desired project name from the appropriate drop-down list. When everything is to your liking, click Save.
The Integrations tab
You can integrate Amplitude Data with your existing tools to streamline your analytics workflow. To integrate a platform, simply click Add next to its name.
The API Tokens tab
Use API tokens to authenticate to Amplitude Data using credentials other than your email address and a password. Tokens authorize applications to enjoy the same roles and permissions granted to you when you log in personally.
To create an API token, click Create Token. Amplitude Data will generate the token and display it in a modal window.
Be sure to click Copy to clipboard now, as you won’t be able to retrieve the token later.
The Schema Settings tab
Sometimes, Amplitude Data might receive data from your app that it doesn't know what to do with. This is usually the result of a schema violation, and it means the received data is not accounted for in your schema. This is usually the result of failing to plan for that particular data type or value when you first set up your schema.
You can tell Amplitude how to handle these situations by configuring your schema settings.
For any unplanned events, event properties, event property types, user properties, or user property types, you can tell Amplitude Data to either mark them as unexpected, or to reject them outright. Amplitude Data will collect any events or properties marked as unexpected and send a notification to everyone subscribed to this schema. If you choose to reject unexpected data, however, Amplitude Data will not collect or store the rejected data. Subscribers will still receive a notification.
Click Save to implement any changes you make to your schema settings.