Standard Events
| Event Name (string) | Description |
|---|---|
page_viewed | A user viewed a page. Typically fired automatically. |
lead_form_completed | A user submitted a form to express interest. |
signup_completed | A user created an account. |
user_logged_in | A user logged in to their account. |
search_performed | A user performed a search. |
item_list_viewed | A user viewed a list of items (e.g. a product category page). |
item_viewed | A user viewed a specific item. |
item_added | A user added an item to their cart. |
checkout_started | A user started the checkout process. |
payment_info_added | A user submitted their payment information. |
purchase_completed | A user completed a purchase. |
trial_started | A user started a free trial. |
trial_converted | A user converted from a free trial to a paid plan. |
subscription_started | A user started a paid subscription without a free trial. |
subscription_renewed | A user’s paid subscription was successfully renewed. |
subscription_cancelled | A user cancelled their subscription. |
Event Properties
| Name | Type | Description |
|---|---|---|
value | Float | A monetary value associated with an event e.g. revenue |
currency | String | The currency of the transaction e.g. “USD” |
customer_type | String | The type of customer for this specific event, for example “new” or “returning”. |
transaction_id | String | A unique ID for the transaction. |
subscription_id | String | A unique ID for the subscription. Only set here if you’re not passing an items array. |
coupon | String | Optional. Discount code that was used. |
discount | Float | The total monetary discount applied to the order. |
shipping | Float | Optional. Cost of shipping. |
tax | Float | Optional. Value added tax. |
delivery_category | String | Optional. e.g. “home_delivery”. |
items | Array | A list of items related to the event. See below for item properties. |
Item Properties
| Name | Type | Description |
|---|---|---|
item_id | String | Unique identifier for the item being purchased. |
item_name | String | Human-readable name of the item. |
is_subscription | Boolean | Indicates whether the item is a subscription or not. |
subscription_id | String | Unique identifier for the subscription. |
affiliation | String | Store or business affiliation from where the item originates. |
coupon | String | Code for any discount coupon applied. |
discount | Float | Monetary discount applied to the item’s price. |
index | Integer | Position index of the item, often used in a list or cart. |
item_brand | String | Brand of the item. |
item_category | String | Category to which the item belongs. |
item_list_id | String | Identifier for the list in which the item appears. |
item_list_name | String | Human-readable name of the list in which the item appears. |
item_variant | String | Specifies the variant of the item (e.g. colour, size). |
location_id | String | Identifier for the store location from where the item was purchased. |
price | Float | Price of a single unit of the item. |
quantity | Integer | Number of units of the item being purchased. |
User Traits
| Name | Type | Description |
|---|---|---|
firstName | String | First name of a user. |
lastName | String | Last name of a user. |
name | String | Full name of a user. If you only pass a first and last name, Fidero automatically fills in the full name for you. |
email | String | Email address of a user. |
phone | String | Phone number of a user. |
title | String | Title of a user, usually related to their position at a specific company. Example: “VP of Engineering”. |
companyName | String | Company the user represents. |
company | Object | Company the user represents, optionally containing: name (String), id (String or Number), industry (String), employeeCount (Number) and plan (String). |
address | Object | Street address of a user optionally containing: street, city, region, state, postalCode, country & countryCode (ISO 3166-1 alpha-2 standard). |
gender | String | Gender of a user. |
birthday | Date | User’s birthday. |
website | String | Website of a user. |
message | String | A message from the user e.g. for lead capture. |
description | String | Description of the user. |
createdAt | String | Date the user’s account was first created. Fidero recommends using ISO-8101 date strings. If not set Fidero will set to the date the event is triggered. |