Reserved or Special Properties

Some property names are reserved for use by Mixpanel and used in a special way. These are different than default collected properties, as they are not collected by default.

Reserved Properties for Events

  • distinct_id - A way to uniquely identify your users. You can set this to any value using the identify method. Some Mixpanel libraries assign a random value by default.
  • ip - If distinct_id is not present, and the event contains a property named 'ip', the value of 'ip' will be used for uniqueness.
  • token - The token used to associate data you send Mixpanel to your account and project.
  • time - A unix time epoch that is used to determine the time of an event. If no time property is provided, we will use the time the event arrives at our servers.
  • length - Incompatible with Mixpanel's JavaScript library
  • campaign_id - Used to build message funnels
  • City ($city) - The city of the event sender, parsed from IP.
  • Region ($region) - The region (state or province) of the event sender, parsed from IP.
  • Country (mp_country_code) - The country of the event sender, parsed from IP.
  • Bucket ($bucket and bucket) - A reserved property that is hidden from the Mixpanel interface, and will cause other events to not appear in the interface. Do not name any property bucket or $bucket. 
  • message_id ($message_id) - A number data type reserved Property that is matched with Message names in the UI.

Reserved Properties for People profiles

  • Email ($email) - The user's email address. You must set this property if you want to send users email from Mixpanel People.
  • Phone ($phone) - The user's phone number. You must set this property if you want to send users SMS from Mixpanel People. Note that a '+' needs to precede phone numbers. This is especially useful for international numbers.
  • $distinct_id - The user's distinct_id. This property value should be identical to the distinct_id property attached to events so that you can connect events to people records.
  • $ios_devices - List of user's Apple Push Notification service device tokens for iOS push. Our iOS client library has methods to manage this property for you.
  • $android_devices - List of user's Google Cloud Messaging registration IDs for Android push. Our Android client library has methods to manage this property for you.
  • $first_name, $last_name, $name - User's first and last names, as well as a general name. These are primarily useful because we will use them, if available, in a few spots in our reports.
  • $transactions - A list with specially formatted JSON objects, one for each purchase or transaction associated with a specific profile. For more information about $transactions, see Tracking revenue in Mixpanel HTTP Tracking API.
  • Created ($created) - The time that the profile was created.
  • City ($city) - The city of the event sender, parsed from IP.
  • Region ($region) - The region (state or province) of the event sender, parsed from IP.
  • Country ($country_code) - The country of the event sender, parsed from IP.
  • Timezone - ($timezone) - The timezone of the event sender, parsed from IP. If set, messages can be scheduled to be sent based on a user's timezone.
  • Unsubscribed - ($unsubscribed) - If this property is set to any value, a user will be unsubscribed from Mixpanel email messages.

Property Name Limitations

Pick your property names wisely. Once you've sent them to Mixpanel, there is no way to change them. Feel free to use capitalization and spaces in between words.

There are a few limitations:

  • Your property names should not begin with $ or mp_. These properties are reserved for special properties sent by Mixpanel.
  • Your property names cannot begin or end with a space as they will automatically be trimmed.
  • Your property names and values cannot be longer than 255 characters. In practice they should be much shorter than that. Property names get cut off by our user interface at about 20 characters.
Is this article helpful?
19 out of 34 found this helpful

Comments

0 comments

Article is closed for comments.