CINXE.COM

<!DOCTYPE html> <html dir="ltr" lang="en-US"> <head><script type="text/javascript" src="https://web-static.archive.org/_static/js/bundle-playback.js?v=7YQSqjSh" charset="utf-8"></script> <script type="text/javascript" src="https://web-static.archive.org/_static/js/wombat.js?v=txqj7nKC" charset="utf-8"></script> <script>window.RufflePlayer=window.RufflePlayer||{};window.RufflePlayer.config={"autoplay":"on","unmuteOverlay":"hidden"};</script> <script type="text/javascript" src="https://web-static.archive.org/_static/js/ruffle/ruffle.js"></script> <script type="text/javascript"> __wm.init("https://web.archive.org/web"); __wm.wombat("https://help.hotjar.com/hc/en-us/articles/4405109971095","20210923063600","https://web.archive.org/","web","https://web-static.archive.org/_static/", "1632378960"); </script> <link rel="stylesheet" type="text/css" href="https://web-static.archive.org/_static/css/banner-styles.css?v=p7PEIJWi" /> <link rel="stylesheet" type="text/css" href="https://web-static.archive.org/_static/css/iconochive.css?v=3PDvdIFv" />  <meta charset="utf-8"/>  <title>Events API Reference – Hotjar Documentation</title> <meta name="description" content="The Events API is not available on the Hotjar Basic plan The Events API is only available for sites on Plus, Business, or Scale plans. To..."/><meta property="og:image" content="https://web.archive.org/web/20210923063600im_/https://theme.zdassets.com/theme_assets/1911667/590ef0f0d048850c7f87d1a4cfb3a8b860062b98.png"/> <meta property="og:type" content="website"/> <meta property="og:site_name" content="Hotjar Documentation"/> <meta property="og:title" content="Events API Reference"/> <meta property="og:description" content="The Events API is not available on the Hotjar Basic plan The Events API is only available for sites on Plus, Business, or Scale plans. To access this feature, follow the steps in this guide to upgr..."/> <meta property="og:url" content="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4405109971095-Events-API-Reference"/> <link rel="canonical" href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4405109971095-Events-API-Reference"/> <link rel="alternate" hreflang="en" href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4405109971095-Events-API-Reference"/> <link rel="stylesheet" media="all" href="//web.archive.org/web/20210923063600cs_/https://static.zdassets.com/hc/assets/application-79172500fb4dbec2484043d570946543.css" id="stylesheet"/> <link rel="stylesheet" type="text/css" href="//web.archive.org/web/20210923063600cs_/https://p23.zdassets.com/hc/theming_assets/1911667/7553308/style.css?digest=4409191257111"> <link rel="shortcut icon" type="image/x-icon" href="//web.archive.org/web/20210923063600im_/https://theme.zdassets.com/theme_assets/1911667/a5ff9dc7fb5929ccf07b4ea5832b09d8c1db3111.ico"/> <script> document.write("<style>body { display: none; }</style>"); if (window.location.href.indexOf('ticket_form_id') > -1) { document.write("<style>#formStartContainer { display: none; }</style>"); document.write("<style>#new_request_div { display: block; }</style>"); } else if (window.location.href.indexOf('requests/new') > -1){ document.write("<style>#new_request_div { display: none; }</style>"); document.write("<style>#formStartContainer { display: block; }</style>"); } document.write("<style>body { display: block; }</style>"); </script> <script src="https://web.archive.org/web/20210923063600js_/https://browser.sentry-cdn.com/5.24.2/bundle.tracing.min.js" integrity="" crossorigin="anonymous"></script> <script> Sentry.init({ dsn: 'https://web.archive.org/web/20210923063600/https://082f1be808ad4f718b96fe072255d59d@o303140.ingest.sentry.io/5443434' }); </script> <script src="https://web.archive.org/web/20210923063600js_/https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" crossorigin="anonymous"></script> <script src="//web.archive.org/web/20210923063600js_/https://static.zdassets.com/hc/assets/moment-f6f8513da6ab17eadada59a1a4edb536.js"></script> <script src="https://web.archive.org/web/20210923063600js_/https://cdn.jsdelivr.net/npm/contentful@latest/dist/contentful.browser.min.js"></script> <script src="https://web.archive.org/web/20210923063600js_/https://cdn.jsdelivr.net/npm/whatwg-fetch@3.4.0/dist/fetch.umd.min.js"></script> <script src="https://web.archive.org/web/20210923063600js_/https://cdn.jsdelivr.net/npm/vue"></script> <script>window.dataLayer = window.dataLayer || [];</script> <script> window.hj = window.hj || function () { (hj.q = hj.q || []).push(arguments); }; </script> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/c32c2e0972e92d620766787403fca9497f9edeb5.js"></script> <link href="//web.archive.org/web/20210923063600cs_/https://theme.zdassets.com/theme_assets/1911667/944e2b9df32a6d0de653db8daa6c22fdad95e52a.css" rel="stylesheet"/> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/25675b06893a9e2547f7da59a7e32fa662e3bc7b.js"></script> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/87cc8bb68f842360700b4d4b9d187fbc8136d19b.js"></script> <link href="//web.archive.org/web/20210923063600cs_/https://theme.zdassets.com/theme_assets/1911667/b71f72fae369531adcfba571b20ad354506e4e60.css" rel="stylesheet"/> <link href="https://web.archive.org/web/20210923063600cs_/https://fonts.googleapis.com/css?family=Open+Sans:400, 400i,600,700" rel="stylesheet"> <script src="https://web.archive.org/web/20210923063600js_/https://use.fontawesome.com/0cffb8d2b1.js"></script> <meta content="width=device-width, initial-scale=1.0" name="viewport"/> <link rel="stylesheet" type="text/css" href="//web.archive.org/web/20210923063600cs_/https://cdn.jsdelivr.net/algoliasearch.zendesk-hc/2/algoliasearch.zendesk-hc.min.css"> <script src="https://web.archive.org/web/20210923063600js_/https://cdn.jsdelivr.net/npm/algoliasearch@4.5.1/dist/algoliasearch.umd.js"></script> <script type="text/javascript" src="//web.archive.org/web/20210923063600js_/https://cdn.jsdelivr.net/algoliasearch.zendesk-hc/2/algoliasearch.zendesk-hc.min.js"></script> <script type="text/javascript"> try { algoliasearchZendeskHC({ applicationId: 'P4FMCMNXV5', apiKey: 'caa07f5c53148135f0db3b874a70494f', subdomain: 'hotjar', indexPrefix: 'zendesk_', analytics: true, // should queries be processed by Algolia analytics baseUrl: '/hc/', // the base URL of your Help Center poweredBy: false, // show the "Search by Algolia" link (required if you're on Algolia's FREE plan) clickAnalytics: true, // whether or not to enable the clickAnalytics feature (available on the Enterprise plan) debug: false, // debug mode prevents the autocomplete to close when trying to inspect it color: '#344258', // main color (used for links) highlightColor: '#344258', // highlight color to emphasize matching text responsive: true, // responsive instantsearch page autocomplete: { enabled: true, // is the autocomplete feature enabled? inputSelector: '#query', // the DOM selector to select the search box hitsPerPage: 5 // the number of suggestions to display }, instantsearch: { enabled: true, // is the instantsearch feature enabled? hitsPerPage: 20, // the number of suggestions to display paginationSelector: '.pagination', // the DOM selector for the current pagination (to hide it) reuseAutocomplete: false, // do not add a search input for the instant-search page hideAutocomplete: true, // whether or not to hide the autocomplete on the instantsearch page (ignored if reuseAutocomplete is used) selector: '.search-results', // the DOM selector for the results container tagsLimit: 15 // maximum number of tags to display } }); } catch { hj('tagRecording', ['algoliasearchZendeskHC_not_defined']); } </script> <script>var sectionBlockLinks = "//web.archive.org/web/20210923063600/https://theme.zdassets.com/theme_assets/1911667/77ae19c65e5de4f2f94ba4d030c6b0fe5f470399.html"</script> <script async src="/web/20210923063600js_/https://help.hotjar.com/cdn-cgi/bm/cv/669835187/api.js"></script></head> <body class=""> <noscript> <style type="text/css"> .content-loading { display:none; } </style> </noscript> <div class="content-loading" style="display:none"> <div class="spinner"></div> </div> <div class="alertbox"></div> <div class="header-wrap"> <header class="header"> <div class="logo"> <a title="Home" href="/web/20210923063600/https://help.hotjar.com/hc/en-us"> <img src="//web.archive.org/web/20210923063600im_/https://theme.zdassets.com/theme_assets/1911667/590ef0f0d048850c7f87d1a4cfb3a8b860062b98.png" alt="Logo"> </a> </div> <div class="nav-wrapper"> <span class="icon-menu"></span> <nav class="user-nav" id="user-nav"> <a class="custom_navbar_link__c" href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/pricing/?utm_source=kb">Pricing</a> <a class="custom_navbar_link__c" href="https://web.archive.org/web/20210923063600/https://trello.com/b/LJOcdoHx/hotjar-public-product-roadmap">Roadmap</a> <a class="custom_navbar_link__c" href="https://web.archive.org/web/20210923063600/https://status.hotjar.com/">System Status</a> <a class="custom_navbar_link__c" href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/">Back to Hotjar.com</a> </nav> <a href="https://web.archive.org/web/20210923063600/https://insights.hotjar.com/register?c=da35c33027914dfded1b7de847f5887a&signup_source=hotjar-docs" class="btn btn-hj">Try It For Free</a> </div> </header> </div> <script src="https://web.archive.org/web/20210923063600js_/https://0b5bdbv94pfm.statuspage.io/embed/script.js"></script> <div class="siteSelectBanner"> <div id="selectContainer" class="alert-note siteSelectWrapper"> <span class="siteSelectTitle">Want more helpful articles based on your Hotjar setup? Choose the site you need help with: </span> </div> </div>  <noscript><iframe src="https://web.archive.org/web/20210923063600if_/https://www.googletagmanager.com/ns.html?id=GTM-WV599XX" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>  <main role="main"> <div class="container-divider"></div> <div class="container"> <nav class="sub-nav"> <ol class="breadcrumbs"> <li title="Hotjar Documentation"> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us">Hotjar Documentation</a> </li> <li title="Development"> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/categories/360002046454-Development">Development</a> </li> <li title="API"> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/sections/360004911073-API">API</a> </li> </ol> <form role="search" class="search" data-search="" data-instant="true" autocomplete="off" action="/web/20210923063600/https://help.hotjar.com/hc/en-us/search" accept-charset="UTF-8" method="get"><input name="utf8" type="hidden" value="?"/><input type="search" name="query" id="query" placeholder="Search" autocomplete="off" aria-label="Search"/></form> </nav> <script>var sectionID = 360004911073</script> <div id="section-blocklinks"> <section-blocklinks :loading="loading" :sibling-sections="siblingSections"></section-blocklinks> </div> <div class="article-container" id="article-container" data-id="4405109971095"> <section class="article-sidebar"> <section class="section-articles collapsible-sidebar"> <h3 class="collapsible-sidebar-title sidenav-title">Articles in this section</h3> <ul> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360023342833-Hotjar-API-" class="sidenav-item ">Hotjar API </a> </li> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4405109971095-Events-API-Reference" class="sidenav-item current-article">Events API Reference</a> </li> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4403030059159-Troubleshooting-FAQs-for-User-Attributes" class="sidenav-item ">Troubleshooting FAQs for User Attributes</a> </li> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4402892526487-What-are-User-Attributes-" class="sidenav-item ">What are User Attributes?</a> </li> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360061197694-User-Attributes-FAQs" class="sidenav-item ">User Attributes FAQs</a> </li> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360033640653-Identify-API-Reference" class="sidenav-item ">Identify API Reference</a> </li> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360038394053-How-to-Setup-User-Attributes-in-4-Steps" class="sidenav-item ">How to Setup User Attributes in 4 Steps</a> </li> <li class=""> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360040652054-How-to-Disable-User-Attributes" class="sidenav-item ">How to Disable User Attributes</a> </li> <li class="no-index-hide"> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360024838193-Advanced-User-Attribute-Setup-Displaying-a-Custom-Survey-to-Customers-Based-On-Attributes-WordPress-WooCommerce-" class="sidenav-item ">Advanced User Attribute Setup: Displaying a Custom Survey to Customers Based On Attributes (WordPress/WooCommerce)</a> </li> </ul> </section> </section> <article class="article"> <header class="article-header"> <h1 title="Events API Reference" class="article-title"> Events API Reference </h1> </header> <section class="article-info"> <div class="article-content"> <div class="article-body"><div class="alert-note"><a name="back_to_top"></a> <h3>The Events API is not available on the Hotjar Basic plan</h3> <p>The Events API is only available for sites on Plus, Business, or Scale plans. To access this feature, follow the steps in this guide to <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/115009346847" target="_self">upgrade your Hotjar plan</a> to one of the paid plans mentioned above.</p> </div> <p>Getting insight from high volumes of data can be time-consuming without segmentation. Hotjar鈥檚 Events API allows you to track specific actions taken by your users and sends that data to Hotjar using Javascript, saving them as <strong>Events</strong>.</p> <p>These events can be used to help you filter and segment Recordings as well as target criteria for a variety of Hotjar tools! <a name="overview"></a></p> <ul> <li><a href="#overview" target="_self">Overview</a></li> <li><a href="#making_calls_to_identify" target="_self" rel="undefined">The Events API call</a></li> <li><a href="#examples" target="_self">Examples</a></li> <li><a href="#best_practices" target="_self">Best Practices</a></li> <li><a href="#test" target="_self" rel="undefined">Testing Events</a></li> </ul> <hr/> <h2>Overview</h2> <p>Hotjar Events represent actions that a user took while on your site. These events are defined and passed to Hotjar through your client-side code via Hotjar's Events API. This API is available on all pages containing the <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/115009336727" target="_self">Hotjar Tracking Code</a>.</p> <p>With JavaScript, you're able to set up your own criteria to determine what kind of action results in an event being sent to Hotjar. The event could be sent as soon as the page loads, when users click on a certain button, or when they see a specific variation of the content through an A/B test.</p> <p>Since the criteria for sending events is based on your own code, the feature is very flexible but will require custom coding from your web developer/team.</p> <p>Events can be used <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360052309773" target="_self" rel="undefined">for targeting Hotjar tools</a> or can be used to <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/115011819928" target="_self" rel="undefined">filter, sort, and segment your session recordings</a>.<a name="making_calls_to_identify"></a></p> <p><a href="#back_to_top" target="_self">Back to top</a></p> <h2>The Events API call</h2> <p>Below is the basic format for a call to the Events API:<span style="background-color: #f7f7f7; font-family: monospace, monospace; font-size: 1em; white-space: pre;"></span></p> <pre><code class="language-javascript">hj('event', 'action_name'); </code></pre> <ul> <li>The first parameter should always contain the string value <strong>event</strong>.</li> <li>The second parameter is the custom name assigned to your event. In the example above the even name is <strong>action_name</strong>, but this can be anything you choose. (Example: 'cta_click', 'opened_modal', 'shown_variant_a', etc.)</li> </ul> <p>There are a couple of limitations to be aware of when implementing these events:</p> <ul> <li><span data-key="124">The event name must not exceed 750 characters and can on</span><span data-key="124">ly contain alphanumeric characters (a-z, A-Z, 0-9), underscores (_), and dashes (-).</span></li> <li><a name="examples"></a> <span data-key="124">You can send up to 1000 events on a Hotjar Site, with an unlimited number of users associated with those events.</span></li> </ul> <div class="alert-success"> <h3>Does Hotjar still support Triggers and Tags added by Javascript?</h3> <p>In the past, Hotjar used <strong>hj('trigger', 'example');</strong> to fire events for targeting purposes, and <strong>hj('tagRecording', ['example_tag_1', 'example_tag_2']);</strong> for attaching tags for filtering recordings. These events were referred to as Javascript Triggers and Tags.</p> <p>If your site is already using the 'trigger' or 'tagRecording' calls, Hotjar will still respect these and they will not stop working. However, we're combining them both into the 'event' call that we will continue building on in the future.</p> </div> <p><a href="#back_to_top" target="_self">Back to top</a><a name="handling_user_ids"></a></p> <h2>Examples</h2> <p>Below are a few example use cases for events:</p> <p>Send an event to Hotjar that you can use to trigger a Survey when a user clicks on a Subscribe button:</p> <pre><code class="language-javascript">hj('event', 'subscribed_to_email_list'); </code></pre> <p>Send an event to Hotjar related to a specific error, so that you can filter your recordings by users who encountered an error during their session:</p> <pre><code class="language-javascript">hj('event', 'error_occurred'); </code></pre> <p>Send an event to Hotjar to let you know when a user loads a specific page variant during an A/B test:<a name="best_practices"></a></p> <pre><code class="language-javascript">hj('event', 'variant_b_displayed'); </code></pre> <p><em>Learn more: <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/360052309773" target="_self" rel="undefined">How to Use Events for Targeting Hotjar Tools</a></em></p> <h2>Best Practices</h2> <div class="alert-danger"> <h3>Do not pass Personal Identifying Information as an Event</h3> <p>Personal-identifying information (PII) should never be used as events in Hotjar. If you'd like to connect session data with specific users, you should explore the <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4402892526487" target="_self" rel="undefined">User Attributes</a> feature instead.<a style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif;" name="user_attribute_values"></a></p> </div> <p> </p> <h3>Combining Event API calls with Identify API calls for targeting Surveys/Incoming Feedback</h3> <p>If you plan on combining Events with <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/4402892526487" target="_self">User Attribute</a>-based targeting for Surveys or Incoming Feedback, you should ensure that the Identify API call has happened <strong>before</strong> the Event API call, in your order of execution, bearing in mind any asynchronous calls to other services. If the Event API call is executed before the Identify API call has finished execution, the Survey/Incoming Feedback will not show. </p> <h3>Sending Events after the Hotjar Tracking Code has loaded</h3> <p><a name="test"></a> If your Event script is added before your Hotjar tracking code, there will be an error and the event will not be recognized.</p> <p>The <strong>hj()</strong> object cannot be accessed until the Hotjar Tracking Code has executed on the page. If for any reason the Event API may be accessed before the tracking code has executed, you can add the following line of code before the Event API code is called:</p> <pre><code class="language-javascript">window.hj=window.hj||function(){(hj.q=hj.q||[]).push(arguments)};</code></pre> <h2>Testing Events</h2> <p>Following the steps below will allow you to confirm if your Events API calls are successfully received by Hotjar. If you're not familiar with your browser console or developer tools, consider looping in a team member who has more knowledge of these tools or a web developer to assist you.</p> <p class="step" data-step="1">Enable Hotjar debug logs in your browser console</p> <p>Open the page where you want to test the Event and add the <strong>?hjDebug=1</strong> parameter to the end of the URL. Here are a couple of examples of what it might look like:</p> <pre>https://www.example.com/<strong>?hjDebug=1<br/>OR<br/></strong>https://www.example.com/?utm_1234<strong>&hjDebug=1</strong></pre> <p class="step" data-step="2">Open your browser Console</p> <p>If you're not familiar with your browser developer tools, or the Console, check out <a href="https://web.archive.org/web/20210923063600/https://webmasters.stackexchange.com/questions/8525/how-do-i-open-the-javascript-console-in-different-browsers" target="_blank" rel="noopener">this guide</a> to learn how to open your browser console. Below are some keyboard shortcuts for a few popular browsers:</p> <p>Chrome - <strong>Cmd+Option+J<br/></strong>Firefox - <strong>Cmd+Option+K<br/></strong>Safari - <strong>Cmd+Option+C</strong><br/><br/></p> <p class="step" data-step="3">Fire the event manually</p> <p>To fire your event manually, add the Event API code in your browser Console and press Enter or Return on your keyboard. If the event fired successfully, you'll see a confirmation log similar to this:</p> <p><img src="https://web.archive.org/web/20210923063600im_/https://assets.hotjar.com/cs-team/knowlege_base/events_example_console_command.png"/></p> <p>We also recommend that you go through the steps that your user would, to trigger the event automatically. If the event is fired automatically, then you'll know that your code is implemented successfully.</p> <p>If the same event is detected when fired manually, but not automatically when testing the user journey, then you may need to revisit your code and criteria that determine when the Event API call is sent.</p> <p><a href="#back_to_top" target="_self">Back to top</a></p></div> <div class="article-attachments"> <ul class="attachments"> </ul> </div> </div> </section> <footer> <div class="article-head"> </div> <div class="article-footer"> </div> <div class="article-votes"> <span class="article-votes-question">Was this article helpful?</span> <div class="article-votes-controls" role="radiogroup"> <button type="button" class="button article-vote article-vote-up" data-helper="vote" data-item="article" data-type="up" data-id="4405109971095" data-upvote-count="9" data-vote-count="15" data-vote-sum="3" data-vote-url="/hc/en-us/articles/4405109971095/vote" data-value="null" data-label="9 out of 15 found this helpful" data-selected-class="null" aria-label="This article was helpful" aria-pressed="false">Yes</button> <button type="button" class="button article-vote article-vote-down" data-helper="vote" data-item="article" data-type="down" data-id="4405109971095" data-upvote-count="9" data-vote-count="15" data-vote-sum="3" data-vote-url="/hc/en-us/articles/4405109971095/vote" data-value="null" data-label="9 out of 15 found this helpful" data-selected-class="null" aria-label="This article was not helpful" aria-pressed="false">No</button> </div> <small class="article-votes-count"> <span class="article-vote-label" data-helper="vote" data-item="article" data-type="label" data-id="4405109971095" data-upvote-count="9" data-vote-count="15" data-vote-sum="3" data-vote-url="/hc/en-us/articles/4405109971095/vote" data-value="null" data-label="9 out of 15 found this helpful">9 out of 15 found this helpful</span> </small> </div> <div class="article-more-questions"> Have more questions? <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/requests/new">Submit a request</a> </div> <div class="article-return-to-top"> <a href="#article-container">Return to top<span class="icon-arrow-up"></span></a> </div> </footer> <section class="article-relatives"> <div data-recent-articles></div> <section class="related-articles"> <h2 class="related-articles-title">Related articles</h2> <ul> <li> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCPE%2BENNTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJfYA6UBBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSIwL2hjL2VuLXVzL2FydGljbGVzLzM2MDAyMzM0MjgzMy1Ib3RqYXItQVBJLQY7CFQ6CXJhbmtpBg%3D%3D--9883c9760c5df0101e94b3b3c8ef896b44a23c8e" rel="nofollow">Hotjar API </a> </li> <li> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCA0%2FytRTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJfYA6UBBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSJRL2hjL2VuLXVzL2FydGljbGVzLzM2MDA1MjMwOTc3My1Ib3ctdG8tVXNlLUV2ZW50cy1mb3ItdGFyZ2V0aW5nLUhvdGphci1Ub29scwY7CFQ6CXJhbmtpBw%3D%3D--a01a1faeb9054c3fcfb8a10ed15d3c174ea13bdd" rel="nofollow">How to Use Events for targeting Hotjar Tools</a> </li> <li> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCJdT2CABBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJfYA6UBBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI%2FL2hjL2VuLXVzL2FydGljbGVzLzQ0MDI4OTI1MjY0ODctV2hhdC1hcmUtVXNlci1BdHRyaWJ1dGVzLQY7CFQ6CXJhbmtpCA%3D%3D--eb0013b81686a806ca672ba5284891301866800a" rel="nofollow">What are User Attributes?</a> </li> <li> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCEU%2BytRTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJfYA6UBBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI8L2hjL2VuLXVzL2FydGljbGVzLzM2MDA1MjMwOTU3My1BLUItVGVzdGluZy13aXRoLUhvdGphcgY7CFQ6CXJhbmtpCQ%3D%3D--a423c14d03de77a7dfdf33c0fcd1dd0f35f67cb3" rel="nofollow">A/B Testing with Hotjar</a> </li> <li> <a href="/web/20210923063600/https://help.hotjar.com/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCMXo9dNTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJfYA6UBBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSJML2hjL2VuLXVzL2FydGljbGVzLzM2MDAzODM5NDA1My1Ib3ctdG8tU2V0dXAtVXNlci1BdHRyaWJ1dGVzLWluLTQtU3RlcHMGOwhUOglyYW5raQo%3D--a802008bcf05e0928653de8e96cb47819b8e4f3e" rel="nofollow">How to Setup User Attributes in 4 Steps</a> </li> </ul> </section> </section> </article> </div> <div class="container container-contact-us"> <div class="blocks-list no-padding"> <div class="blocks-item blocks-item-contact block-border"> <p class="category-title-homepage category-title-homepage-space">Still need help?</p> <p>Get help with common questions or reach out to our support team.<br><br><br> <a href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/requests/new" class="button-boxes contact-us">Contact us</a> </p> </div> <div class="blocks-item blocks-item-contact block-border"> <p class="category-title-homepage category-title-homepage-space">Just getting started?</p> <p>Watch our comprehensive demo to help get the most out of Hotjar.<br><br><br> <a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/demo/" class="button-boxes">Watch Demo</a> </p> </div> </div> </div> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/98220b72a4579052905e9512553ba3ebacf08f28.js"></script> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/288c04d152b9b38262fdc96ebb673d9db81515bf.js"></script> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/c13eac4e7174a1ecc13474d808f3003e115cc513.js"></script> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/106a683ca517a0b96146c1e2fff2af0bbf5ad0a9.js"></script> <script src="//web.archive.org/web/20210923063600js_/https://theme.zdassets.com/theme_assets/1911667/38f98bb993cc0c3b6d55fd8e6b693e848b18bd32.js"></script> </main> <footer class="footer"> <div class="logo"> <a title="Home" href="/web/20210923063600/https://help.hotjar.com/hc/en-us"> <img src="//web.archive.org/web/20210923063600im_/https://theme.zdassets.com/theme_assets/1911667/590ef0f0d048850c7f87d1a4cfb3a8b860062b98.png" alt="Logo"> </a> </div> <div class="column"> <h2>HOTJAR</h2> <ul> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/tour">Product Tour</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/pricing">Pricing</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/customers/">Customer Stories</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/updates">Product updates</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/blog/what-is-hotjar/">What is Hotjar?</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://status.hotjar.com/">Status</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/115009335727-Will-Hotjar-Slow-Down-My-Site-">Site performance</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/privacy/">Your privacy & Hotjar</a></li> </ul> </div> <div class="column"> <h2>RESOURCES</h2> <ul> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/blog">Blog</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/guides/">Guides</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us">Documentation</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/heatmaps/">Heatmap handbook</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/conversion-rate-optimization/">CRO action plan</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/customer-experience/">CX resources</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/usability-testing/">Usability testing hub</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/blog/website-feedback/">Website feedback 101</a></li> </ul> </div> <div class="column"> <h2>COMPLIANCE</h2> <ul> <li><a href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/categories/360003405813">Compliance, legal & security</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/legal/policies/terms-of-service">Terms of service</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/legal/policies/privacy">Privacy policy</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/legal/policies/acceptable-use/">Acceptable use policy</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/articles/115011789248">Cookie info</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/privacy/do-not-track/">Do not track</a></li> </ul> </div> <div class="column"> <h2>COMPANY</h2> <ul> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/about-us/">About us</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://careers.hotjar.com/">Careers</a></li> <li><a href="https://web.archive.org/web/20210923063600/https://www.hotjar.com/founding-members/">Founding members</a></li> <li id="footercontactus"><a href="https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us/requests/new?footer">Contact Us</a></li> </ul> </div> <div class="copyright"> <p>Copyright © 2014 - <script>document.write(new Date().getFullYear())</script> Hotjar Ltd. All rights reserved.</p> </div> </footer>  <script src="//web.archive.org/web/20210923063600js_/https://static.zdassets.com/hc/assets/en-us.9c17d79fddaade65344a.js"></script> <script src="https://web.archive.org/web/20210923063600js_/https://hotjar.zendesk.com/auth/v2/host.js" data-brand-id="7553308" data-return-to="https://help.hotjar.com/hc/en-us/articles/4405109971095" data-theme="hc" data-locale="en-us" data-auth-origin="7553308,true,true"></script> <script type="text/javascript"> /* Greetings sourcecode lurker! This is for internal Zendesk and legacy usage, we don't support or guarantee any of these values so please don't build stuff on top of them. */ HelpCenter = {}; HelpCenter.account = {"subdomain":"hotjar","environment":"production","name":"Hotjar"}; HelpCenter.user = {"identifier":"da39a3ee5e6b4b0d3255bfef95601890afd80709","email":null,"name":null,"role":"anonymous","avatar_url":"https://web.archive.org/web/20210923063600/https://assets.zendesk.com/hc/assets/default_avatar.png","is_admin":false,"organizations":[],"groups":[]}; HelpCenter.internal = {"asset_url":"//web.archive.org/web/20210923063600/https://static.zdassets.com/hc/assets/","web_widget_asset_composer_url":"https://web.archive.org/web/20210923063600/https://static.zdassets.com/ekr/snippet.js","current_session":{"locale":"en-us","csrf_token":"hc:hcobject:server:NU1Y3V1ERx31ev4LrTrGTlDH5ElBXBvYwXwqsqXVIH0hqcjk8XMbRd9CqiXJ9tyUztPEBl_WtNTEG6uGMcI1Hg","shared_csrf_token":null},"settings":{},"usage_tracking":{"event":"article_viewed","data":"BAh7CDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoPYXJ0aWNsZV9pZGwrCJfYA6UBBDoKX21ldGF7CzoPYWNjb3VudF9pZGkDcysdOhNoZWxwX2NlbnRlcl9pZGwrCJ/Si8YaADoNYnJhbmRfaWRpAxxBczoMdXNlcl9pZDA6E3VzZXJfcm9sZV9uYW1lSSIOQU5PTllNT1VTBjsGVDsASSIKZW4tdXMGOwZU--d3ce184ec0fac5452b4fb3dfc99984b2e4aafc51","url":"https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/activity"},"current_record_id":"4405109971095","current_record_url":"/hc/en-us/articles/4405109971095-Events-API-Reference","current_record_title":"Events API Reference","search_results_count":null,"current_text_direction":"ltr","current_brand":{"account_id":1911667,"brand_id":7553308,"brand_url":"https://web.archive.org/web/20210923063600/https://help.hotjar.com","url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/api/v2/brands/7553308.json","name":"Hotjar","logo":"","subdomain":"hotjar","host_mapping":"help.hotjar.com","help_center_state":"enabled","ticket_form_ids":null,"active":true,"default":true,"has_help_center":true,"created_at":"2017-05-25T16:46:00Z","updated_at":"2020-08-07T20:54:13Z","id":7553308,"route_id":1846042},"current_brand_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com","current_host_mapping":"help.hotjar.com","current_path":"/hc/en-us/articles/4405109971095-Events-API-Reference","authentication_domain":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com","show_autocomplete_breadcrumbs":true,"rollbar_config":{"enabled":true,"endpoint":"https://web.archive.org/web/20210923063600/https://rollbar-us.zendesk.com/api/1/item/","accessToken":"731a5a953e9a4b7ab6cac9623f50c732","captureUncaught":true,"captureUnhandledRejections":true,"payload":{"environment":"production","client":{"javascript":{"source_map_enabled":true,"code_version":"48ab3c15be0ec12eeb87a9c901049a7aeaa34be2","guess_uncaught_frames":true}}}},"user_info_changing_enabled":false,"has_user_profiles_enabled":true,"has_end_user_attachments":true,"user_aliases_enabled":true,"has_anonymous_kb_voting":true,"has_multi_language_help_center":true,"mobile_device":false,"mobile_site_enabled":false,"show_at_mentions":true,"embeddables_config":{"embeddables_web_widget":false,"embeddables_connect_ipms":false},"base_domain":"zendesk.com","answer_bot_subdomain":"static","manage_content_url":"https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/en-us","arrange_content_url":"https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/admin/arrange_contents?locale=en-us","general_settings_url":"https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/admin/general_settings?locale=en-us","user_segments_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/knowledge/user_segments?brand_id=7553308","has_gather":true,"has_community_enabled":false,"has_community_badges":false,"has_user_segments":true,"has_answer_bot_web_form_enabled":false,"has_answer_bot_web_form_modal_v2":false,"has_edit_user_profile_v2":false,"billing_url":"/access/return_to?return_to=https://hotjar.zendesk.com/admin/billing/subscription","is_account_owner":false,"theming_cookie_key":"hc-da39a3ee5e6b4b0d3255bfef95601890afd807091-preview","is_preview":false,"has_guide_user_segments_search":true,"has_alternate_templates":true,"arrange_articles_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/knowledge/arrange?brand_id=7553308","article_verification_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/knowledge/verification?brand_id=7553308","has_article_verification":true,"guide_language_settings_url":"https://web.archive.org/web/20210923063600/https://help.hotjar.com/hc/admin/language_settings?locale=en-us","docs_importer_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/knowledge/import_articles?brand_id=7553308","community_badges_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/knowledge/community_badges?brand_id=7553308","community_settings_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/knowledge/community_settings?brand_id=7553308","gather_plan_state":"subscribed","search_settings_url":"https://web.archive.org/web/20210923063600/https://hotjar.zendesk.com/knowledge/search_settings?brand_id=7553308","has_multibrand_search_in_plan":true,"theming_api_version":2,"has_pci_credit_card_custom_field":true,"current_brand_id":7553308,"help_center_restricted":false,"current_brand_active":true,"is_assuming_someone_else":false,"flash_messages":[],"user_photo_editing_enabled":true,"has_end_user_apps":false,"has_docs_importer":true,"has_sunco_widget":false,"gather_user_image_upload_via_aus":false,"user_preferred_locale":"en-us"}; </script> <script src="//web.archive.org/web/20210923063600js_/https://static.zdassets.com/hc/assets/hc_enduser-9fa4fabcc25ad7ce2141d33e2370693a.js"></script> <script type="text/javascript" src="//web.archive.org/web/20210923063600js_/https://p23.zdassets.com/hc/theming_assets/1911667/7553308/script.js?digest=4409191257111"></script> <script type="text/javascript">(function(){window['__CF$cv$params']={r:'6931c1953d443812',m:'unPpCdHTLYHnF3mBfP55SxZbdbjNUq_3N4M6fL5cbw8-1632378960-0-AVBBuNJUw6p0p1tbrjjc0uf4uNFfU068YOrWZ5hKmJlBJy4PiqTwwTCuM79bofLvafVf8FmsQcniT/ifb5dYOWXJBTchitGBxpoybbmNXAiT1FJZdK159Hl2lT/sy6thkm1CmyN/eAjTVP113qpihXlZDQlwGCxu/DGxwXB30xIS',s:[0xc8df902bc0,0x6645fae71d],}})();</script></body> </html>