Events
AIDEM Stream support the following events (case sensitive).
General
Website action | Description | Standard event code |
Page view | A visit to a any page on your website. | aidemstream('track', 'PageView'); |
Add payment info | The addition of customer payment information during a checkout process. | aidemstream('track', 'AddPaymentInfo'); |
Add to cart | The addition of an item to a shopping cart or basket. | aidemstream('track', 'AddToCart'); |
Add to wishlist | The addition of items to a wishlist. | aidemstream('track', 'AddToWishlist'); |
Complete registration | A submission of information by a customer in exchange for a service provided by your business. | aidemstream('track', 'CompleteRegistration'); |
Contact | A telephone, SMS, email, chat or other type of contact between a customer and your business. | aidemstream('track', 'Contact'); |
Customise product | The customisation of products through a configuration tool or other application. | aidemstream('track', 'CustomizeProduct'); |
Donate | The donation of funds to your organisation or cause. | aidemstream('track', 'Donate'); |
Donate Recurring | Recurring donation funds to your organization or cause. | aidemstream('track', 'DonateRecurring'); |
Find location | When a person finds one of your locations via web, with an intention to visit. | aidemstream('track', 'FindLocation'); |
Initiate checkout | The start of a checkout process. | aidemstream('track', 'InitiateCheckout'); |
Lead | A submission of information by a customer with the understanding that they may be contacted at a later date. | aidemstream('track', 'Lead'); |
Purchase | The completion of a purchase. | aidemstream('track', 'Purchase'); |
Schedule | The booking of an appointment to visit one of your locations. | aidemstream('track', 'Schedule'); |
Search | A search performed on your website, app or other property. | aidemstream('track', 'Search'); |
Start trial | The start of a free trial of a product or service you offer. | aidemstream('track', 'StartTrial'); |
Submit application | The submission of an application for a product, service or programme that you offer. | aidemstream('track', 'SubmitApplication'); |
Subscribe | The start of a paid subscription for a product or service you offer. | aidemstream('track', 'Subscribe'); |
View content | A visit to a web page you care about. | aidemstream('track', 'ViewContent'); |
Telco
If you are a Telco, you can also leverage these events:
Website action | Description | Standard event code |
Coverage Check | A submission of information by a customer to check service coverage. | aidemstream('track', 'CoverageCheck'); |
Call Me Back | A call back request by a customer with the understanding that they may be contacted by your business. | aidemstream('track', 'CallMeBack'); |
Click To Call | A customer initiated telephone, SMS, email, chat or other type of contact between a customer and your business. | aidemstream('track', 'ClickToCall'); |
Automotive
If you are an Automotive company, you can also leverage these events:
Website action | Description | Standard event code |
Download Brochure | The download of a pdf. brochure. | aidemstream('track', 'DownloadBrochure'); |
Testdrive Request | The request for a trial of a car. | aidemstream('track', 'TestdriveRequest'); |
Dealer Lookup | The search for a car dealer. | aidemstream('track', 'DealerLookup'); |
Configurator Completion | Completion of the carline configuration | aidemstream('track', 'ConfiguratorCompletion'); |
Payloads
Every payload accepts an event_id field which must be a unique identifier of the transaction. For more information, see Conversion API.
Donate payload
Field | Type | Description |
price | Number; Optional | The price of the Donate event |
currency | String; Optional | The currency of the Donate event. For more information, see List of currencies. |
Donate Example
<script>
aidemstream('track', 'Donate', {price: 9.99, currency: 'USD'})
</script>
Donate Recurring payload
Field | Type | Description |
price | Number; Optional | The price of the DonateRecurring event |
currency | String; Optional | The currency of the DonateRecurring event. For more information, see List of currencies. |
Donate Recurring Example
<script>
aidemstream('track', 'DonateRecurring', {price: 9.99, currency: 'USD'})
</script>
Purchase payload
Field | Type | Description |
price | Number; Optional | The price of the Purchase event |
currency | String; Optional | The currency of the Purchase event. For more information, see List of currencies. |
units | Number; Optional | The number of purchased items. |
order_id | String; Optional | Unique order_id for conversions matching |
Purchase Example
<script>
aidemstream('track', 'Purchase', {price: 9.99, currency: 'USD', units: 3, order_id: 'test_value'})
</script>
Start trial payload
Field | Type | Description |
price | Number; Optional | The price of the StartTrial event |
currency | String; Optional | The currency of the StartTrial event. For more information, see List of currencies. |
Start trial Example
<script>
aidemstream('track', 'StartTrial', {price: 9.99, currency: 'USD'})
</script>
Subscribe payload
Field | Type | Description |
price | Number; Optional | The price of the Subscribe event |
currency | String; Optional | The currency of the Subscribe event. For more information, see List of currencies. |
Subscribe Example
<script>
aidemstream('track', 'Subscribe', {price: 9.99, currency: 'USD'})
</script>