To install the WordPress plugin, please follow these steps:
- Login to your WordPress admin dashboard. Choose Plugins > Add New from the left column menu. Note: For WordPress installations with many add-ons, you may need to scroll down to see the Plugins menu link.
- In the search field on the right side of the white menu bar, search for the word: OptiMonk.
- Click on the Install Now button for Exit-Intent Popups by Optimonk. Note: Look for the official plug-in with the OptiMonk logo.
- Click on OK in the confirmation window. Wait for the installation to complete. After the installation completes, you will be redirected to a page on your WordPress dashboard that confirms the installation of the plugin. Click on Activate Plugin, this will activate OptiMonk on your WordPress site and redirect you to the settings page for the OptiMonk plugin. Note: In case you get lost, you can always find the OptiMonk plugin settings page by clicking on Appearances > OptiMonk in the left column menu of your WordPress Dashboard.
- Once you reach the OptiMonk plugin settings page, you’ll need your Account ID from OptiMonk. You can find your Account ID at the bottom of the main page in your OptiMonk dashboard. Open a new browser window and login to your OptiMonk dashboard. Scroll down to the bottom and click on the WordPress tab below ‘Start using OptiMonk on your website’. You’ll see your Account ID listed in bold type, copy or make note of this number. Return to the OptiMonk plugin settings page in your WordPress dashboard and paste or type it in the Account ID.
Congratulations, you’re now setup to use OptiMonk with WordPress!
For more advanced users, we’ve created a set of custom variables to use with WordPress sites.
The following custom variables shall be referred to as "wp_[variable name]".
We store the following in custom variables:
utm_campaign, utm_source, utm_medium: If they are given in the URL, then these are not deleted, they are overwritten.
source: Contains the URL of the referral source, often coming from different domains, default: Direct.
referrer: Contains the URL of the previous page, default: Direct.
visitor_type: Role of the visitor on the site, example: administrator, default: logged out.
visitor_login_status: The login status of the visitor on the site, values: logged out, logged in.
visitor_id: The ID of the visitor on the site.
page_title: Name of the current page.
post_type: Type of post. If it cannot be defined, then: unknown.
post_type_with_prefix: Type of post completed with a prefix. Prefix values: single, author, category, tag, day, month, year, time, date, tax.
post_categories: Categories of the post, if there are more than one, then separated with: "|".
post_tags: Tags of the post, if there are more than one, then separated with: "|".
post_author: Author of the post.
post_full_date: Exact and full date of the post. Based on the date format set in Settings -> General.
post_year: Year of the post.
post_month: Month of the post. For single-digit months, use a "0" prefix, example: September is "09".
post_day: Day of the post. For single-digit days, use a "0" prefix, example: The first day of month it is "01".
is_front_page: If the current page is the main page, the value is "1", for any other page the value is "0". The value "1" is assigned to the page set in Settings -> Reading -> "Front page displays".
search_query: The expression searched for in any queries.
search_result_count: Number of search results.
Additional custom variables with WooCommerce plugin:
cart_total_without_discounts: Full price of cart, without discounts.
cart_total: Final price of cart, with discounts.
number_of_item_kinds: The number of different products.
total_number_of_cart_items: The number of cart items.
applied_coupons: Applied coupons, if there are more than one, then separated with: "|".
current_product.name: Name of the product currently being viewed.
current_product.sku: Item number of the product currently being viewed.
current_product.price: Price of the product currently being viewed.
current_product.stock: Stock or inventory level of the product currently being viewed, if it is set.
current_product.categories: Categories of the product currently being viewed, if there are more than one, then separated with: "|".
current_product.tags: Tags of the product currently being viewed, if there are more than one, then separated with: "|".
To use the additional custom variables with the WooCommerce plugin, you need to run your ecommerce store using WooCommerce. The full details of setting up WooCommerce are outside of the scope of this guide. These are the basic steps required to install the plugin:
- Choose Plugins > Add new from the left column menu in your WordPress Dashboard.
- In the search field on the right of the white menu bar, search for the word ‘WooCommerce’ and click on the Install Now button to install the plugin. Be sure to install the official plugin developed by WooThemes.
Congratulations, you’re now setup to use OptiMonk with WooCommerce! Please refer to the documentation from WooCommerce for further details on setting up your store.