Events Special Properties

You can use any UTF-8 string to name your additional properties of events, but some property names have special significance to Replay. You should only use special event properties for their intended meaning.

Property Type Description
amount Float Amount of revenue generated by the event (e.g. 6.99)
app_version String What version of the app the user is on (e.g. “4.1.2”)
client_os String What operating system the user is using
client_sdk String What client SDK is sending the event data
device_brand String The brand of the user’s device (e.g. “Samsung”)
device_carrier String The carrier the user has (e.g. “Verizon”)
device_id String A device specific identifier
device_manufacturer String The manufacturer of the user’s device (e.g. “Samsung”)
device_model String The model the user’s device (e.g. “Galaxy”)
device_type String What device the user is on (e.g. “Samsung Galaxy”)
country String The country the user is in
event_category String The category of an event. By default, this field is set to “general”
ip String An IP address string associated with the event (e.g. “127.0.0.1”)
language String The language the user has set
latitude Float The latitude of the user (e.g. 36.77)
longitude String The longitude of the user (e.g. -112.29)
page_name String A string representing the page associated with the event
page_url String The URL of the page associated with the event
past_event 0 or 1 Set to 1 if you’re manually passing us the timestamp. This is used for importing events that occurred in the past, and is set to 0 by default
timestamp Integer The value represents the time delta (in milliseconds) between when the event occurred and the time the event was sent. Negative values can be used to send past events to Replay.

Traits Special Properties

You can use any UTF-8 string to name the additional properties of your user, but some property names have special significance for clear mapping to analytics providers.

Property Type Description
address Object An object with street, city, state, state_code, country, country_code, or zip keys with their respective values { street: '1234 Example St.', state: 'Colorado', state_code: 'CO', country: 'US', country_code: 'USA', zip: '123455'}
age Number The age of the user
birthday String The user’s birthday (e.g. “01-01-1994”)
avatar String A URL to an avatar image for the user
created_at Integer The time the user’s profile was first created. The value should be a unix timestamp (milliseconds since midnight, January 1st, 1970 - UTC)
company String The name of the company
description String A description of the user
email String The user’s email
employees Number The number of employees of a group
fax String A string representation of the user’s fax number (e.g “6157653315”)
first_name String The user’s first name
gender String The user’s gender
industry String The industry in which the user works
ip String An IP address string associated with the user
last_name String Last name of the user represented by the profile
mobile_phone String A string representation of the user’s phone number (e.g “7218675309”)
name String Can be set to the user’s full name as an alternative to having two separate first and last name properties
page_name String The name of the page associated with the user
page_url String The URL associated with the user
past_event 0 or 1 Set to 1 if you’re manually passing us the timestamp. This is used for importing events that occurred in the past, and is set to 0 by default.
phone String A string representation of the user’s phone number (e.g. “7195552331”)
salutation String Salutation for the user
timestamp Integer The value represents the time delta (in milliseconds) between when the trait was recorded and the time the trait was sent. Negative values can be used to send past trait events to Replay.
title String The title of a user, usually related to their position at a specific company, for example “VP of Design”
website String A user’s website