A. Introduction
For current or prospective Amplitude customers who prefer to avoid the often lengthy and complex process of manually instrumenting events, Convizit offers an appealing alternative. With no need for a tagging plan or manual event coding, Convizit’s AI-driven solution automatically collects user behavior data in websites and web applications. Convizit sends this event data – already named and property-enriched – into Amplitude for reporting and analysis.
After adding Convizit’s JavaScript tag to a website/application, no further development resources or technical knowledge are required (e.g., there is no need to touch JavaScript or CSS selectors). A friendly visual interface makes it is easy for you to control which events are sent to Amplitude, how they are named and which properties they contain.
On-demand historical data backfill allows additional behavioral analysis at any time, by sending additional historical data into Amplitude, even if you initially decided not to receive those events and/or properties. And Convizit handles ongoing website changes automatically so that funnels and reports don’t break; no event tracking maintenance is required.
Convizit’s direct integration with Amplitude allows you to quickly and easily realize the full potential of the platform within days of deployment, with little or no manual effort required. This document describes how this integration works.
B. Getting Started
This is the process to begin receiving event data from your website/application into Amplitude via Convizit:
1. Add the Convizit tag to your website or application
Place the JavaScript snippet you received from Convizit at the beginning of the <head> … </head> section of every page of your website. Details about doing this can be found here: Deploying the Convizit Tag
As soon as the Convizit tag is operational in your website/application, Convizit will begin collecting, naming and structuring the user behavior data.
2. Provide Convizit with some information
Send your Convizit contact person your Amplitude Application ID, Application name and API key (to find these details, see Find your API Credentials).
3. Customize the data that Convizit collects (OPTIONAL)
- To associate your own known customer IDs with Convizit’s event data (highly recommended), see: Customer Identification and Enrichment
- To prevent Convizit from capturing clicks on specific website elements, see: Ensuring Data Privacy
- To add your own events and/or event properties to Convizit’s event data (using JavaScript), see: Coded Events and Coded Properties
4. Convizit will deliver your user behavior data into Amplitude
- Convizit will typically begin sending data into Amplitude within about one week from the time the Convizit tag is added to your website. Low-traffic sites might take longer (Convizit’s AI needs a certain amount of actual user traffic in order to accurately model a website or application).
- Convizit sends data into Amplitude every 30 minutes.
- If, at any time, you wish to pause data delivery into Amplitude, inform your Convizit contact person.
5. Validate that you are receiving data from Convizit
You can see the events arriving from Convizit in Amplitude in the User Look-Up page. Note that it can take a few additional minutes for the data to appear on this page after it was received from Convizit.
If you also have other sources of event data in Amplitude, follow these steps to confirm that events from Convizit’s are arriving in Amplitude:
- Navigate to the User Look-Up page and click a recent User ID.
- Scroll down into the Event Stream area and click the Raw button.
- You will know that you are looking at an event delivered to Amplitude from Convizit with you see “source”: “Convizit” in the JSON code:
C. Customizing the Data Delivered by Convizit into Amplitude
Using Convizit’s visual interface, you can easily understand the data that Convizit is capturing, and adjust how events and properties are delivered into Amplitude:
- Review all the events and properties that Convizit is capturing.
- Select which events to receive in Amplitude.
- Change the names of events and event properties.
- Exclude specific event properties from some/all events.
D. The Amplitude Fields Populated by Convizit
For more technical users familiar with Amplitude, these are the specific fields that Convizit populates in Amplitude for each delivered event:
insert_id | Convizit’s unique identifier of the event |
user_id | Convizit’s unique identifier of the website visitor |
time | Timestamp of the event |
event_type | The name of the event (e.g., “Add to cart”, “Size chart click”) |
event_properties | An array of customizable event-specific properties as key:value pairs (e.g., “Add to cart” event properties might include “Product name”, “Product price”, “Selected color” and “Quantity”) |
user_properties | An array of key:value pairs when available: customerId, GoogleId, FacebookId |
utm_source | UTM Source parameter provided for the session, if available |
utm_medium | UTM Medium parameter provided for the session, if available |
utm_campaign | UTM Campaign parameter provided for the session, if available |
utm_term | UTM Term parameter provided for the session, if available |
utm_content | UTM Content parameter provided for the session, if available |
deviceType | Visitor’s device type (e.g., desktop, tablet, mobile) |
plan.source | Equal to “Convizit” (allows identifying and segmenting Convizit-delivered data in Amplitude reports and analyses) |
Additional data included as properties with each event: | |
platform | Platform of the user’s device |
os_name | The name of the mobile operating system or browser |
os_version | The version of the mobile operating system or browser |
device_brand | The brand of the user’s device |
ip | The user’s IP address |
country region city |
Automatically populated by Amplitude if IP address is supplied |