Getting Started with the Monetate Travel API
The Monetate Travel API allows you to pass data from your site to the Monetate platform. For best results you should track each page of your site. To do this, you must implement the following:
- Monetate Inspector browser plug-in: Verifies the functionality and placement of the Monetate tag on a page
The Travel API has nine total API methods, three for each type of travel site. Each method call has a series of attributes with information from the current page. Some of these attributes are required while some are optional. That said, you should include as many methods as you can to capture the information on your site pages. All attributes are represented as arrays, even if they only hold a single value.
In addition to the nine API methods specific to the Travel API, you must also implement two standard calls:
The time needed to add the Monetate tag and the required method calls that are important to your business can vary. The number of method calls you need to add, your intended use of Monetate, and the skill set of the person completing these tasks can all affect how long it takes to complete the process. For more information about who should complete the various steps of this process and what to expect, see Implementation User Roles.
You can call Monetate Travel API methods with the standard window.monetateQ.push feature. Additionally, this requires an object that contains all the attributes that you need to collect all of the required information on your site's page. You can create this object beforehand or during the method call. The fields in the object can be integers or strings.
Use the add{travel_type}Search methods when a customer searches on your site. Use the add{travel_type}Review methods when a customer has selected a cruise, hotel, or flight. Use the add{travel_type}Booking methods when a customer completes a purchase.
The add{travel_type}Review and add{travel_type}Booking methods also receive attributes with purchase information: product ID, quantity, price, currency, and order ID.
This table contains the method calls related to cruise bookings.
Method | Description |
Passes information from your site to Monetate when a customer searches for a cruise | |
Passes information from your site to Monetate when a customer adds a cruise to the cart | |
Passes information from your site to Monetate when a customer completes purchasing a cruise |
This table contains the method calls related to hotel bookings.
Method | Description |
Passes information from your site to Monetate when a customer searches for a hotel | |
Passes information from your site to Monetate when a customer adds a hotel stay to the cart | |
Passes information from your site to Monetate when a customer completes purchasing a hotel stay |
This table contains the method calls related to airline ticket purchases.
Method | Description |
Passes information from your site to Monetate when a customer searches for a flight | |
Passes information from your site to Monetate when a customer adds a flight ticket to the cart | |
Passes information from your site to Monetate when a customer completes purchasing a flight ticket |