coveo-search-ui

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ISearchEvent | Coveo JavaScript Search Framework - Reference Documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="https://use.typekit.net/bqa0xml.css"></link> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/all.min.css" /> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/overrides.css"> <link rel="stylesheet" href="../assets/css/coveo-connect-header.css"> <link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10122/css/CoveoFullSearch.min.css" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script> <script type="text/javascript" src="https://static.cloud.coveo.com/coveo.analytics.js/coveoua.js"></script> <script src="../assets/js/modernizr.js"></script> <script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10122/js/CoveoJsSearch.min.js"></script> <script src="../assets/js/coveo-connect-header.js"></script> <script src="../assets/gen/js/playground.js"></script> <script src="../assets/js/searchUIrefDoc.js"></script> <link href="../assets/favicon.ico" rel="shortcut icon" type="image/x-icon"> </head> <body> <header class="no-sticky"> <div class="content"> <div class="main-header"> <div class="logo"> <a class="logo-img-wrap" href="https://coveo.com"> <div class="logo-imgbg"> <svg width="124" height="32" viewBox="0 0 409 104" fill="none" xmlns="http://www.w3.org/2000/svg"> <g clip-path="url(#clip0)"> <path d="M164.7 36.2L159.8 41.4C156.4 38.1 152.8 36.2 147.9 36.2C139.4 36.2 133 42.9 133 52.3C133 61.7 139.4 68.4 147.9 68.4C152.5 68.4 156.9 66.5 160.1 63.2L164.7 68.4C160.7 73 155 75.4 148.3 75.4C134.3 75.4 125.2 65.4 125.2 52.3C125.2 38.9 134.3 28.9 148.3 28.9C154.6 28.8 160.6 31.5 164.7 36.2Z" fill="white"/> <path d="M219.4 52.3C219.4 65.4 209.4 75.4 196 75.4C182.3 75.4 172.3 65.4 172.3 52.3C172.3 38.9 182.3 28.9 196 28.9C209.4 28.9 219.4 38.9 219.4 52.3ZM180.2 52.3C180.2 61.7 186.9 68.4 196 68.4C204.8 68.4 211.5 61.7 211.5 52.3C211.5 42.9 204.8 36.2 196 36.2C186.9 36.2 180.2 42.9 180.2 52.3Z" fill="white"/> <path d="M252.3 74.5H243.1L224.3 30.1H232.8L247.7 66.9L262.6 30.1H270.8L252.3 74.5Z" fill="white"/> <path d="M318.8 52V55H283.8C284.7 64.1 291.1 68.7 298.7 68.7C303.8 68.8 308.8 66.9 312.7 63.5L316.7 68.7C311.2 73.9 305.1 75.5 298.4 75.5C285 75.5 275.6 66.4 275.6 52.4C275.6 38.7 285 29 297.8 29C310 28.9 318.8 38.6 318.8 52ZM283.9 48.6H311.3C310.4 41 305.2 35.8 297.9 35.8C290 35.9 285.1 41 283.9 48.6Z" fill="white"/> <path d="M376 52.3C376 65.4 366 75.4 352.6 75.4C338.9 75.4 328.9 65.4 328.9 52.3C328.9 38.9 338.9 28.9 352.6 28.9C365.9 28.9 376 38.9 376 52.3ZM336.8 52.3C336.8 61.7 343.5 68.4 352.6 68.4C361.4 68.4 368.1 61.7 368.1 52.3C368.1 42.9 361.4 36.2 352.6 36.2C343.4 36.2 336.8 42.9 336.8 52.3Z" fill="white"/> <path d="M88.1 14.9C79.5 6.4 68.3 1.2 56.2 0C55.3 0 54.6 0.8 54.6 1.8C54.6 2.2 54.7 2.5 55 2.8L73.8 21.3C73.8 21.6 73.8 21.6 73.5 21.6C68.3 17.8 62.2 15.5 55.9 14.9C55.3 14.8 54.8 15.2 54.7 15.8C54.7 16.1 54.8 16.4 55 16.7L67.8 29.5C67.8 29.5 67.8 29.8 67.5 29.5C64 27.3 60.1 25.9 55.9 25.5C55.3 25.5 55 26.1 55.3 26.7L76.9 48.3C77.5 48.9 78.4 48.3 78.1 47.7C77.8 43.6 76.4 39.6 74.1 36.1C73.8 36.1 74.1 35.8 74.1 36.1L86.6 48.3C87.2 48.9 88.4 48.3 88.4 47.4C87.7 41 85.4 34.8 81.7 29.5C81.4 29.5 81.7 29.2 81.7 29.5L100.6 48C101.1 48.6 101.9 48.7 102.5 48.3C103 48 103.2 47.4 103 46.8C101.9 34.7 96.6 23.4 88.1 14.9Z" fill="#00ADFF"/> <path d="M14.9 14.9C23.6 6.5 34.8 1.2 46.8 0C47.7 0 48.4 0.6 48.5 1.5C48.5 1.9 48.4 2.4 48 2.7L29.5 21.3C29.2 21.6 29.5 21.6 29.5 21.6C34.8 17.8 41 15.5 47.4 14.9C48.3 14.9 48.9 16.1 48.3 16.7L35.6 29.5C35.3 29.5 35.6 29.8 35.6 29.5C39.1 27.3 43 26 47.2 25.5C47.8 25.5 48.4 26.1 47.8 26.7L26.1 48.3C25.5 48.9 24.9 48.3 24.9 47.7C25.3 43.6 26.8 39.6 29.2 36.1C29.2 36.1 28.9 35.8 28.9 36.1L16.7 48.3C15.8 48.9 14.6 48.3 14.9 47.4C15.5 40.9 17.8 34.7 21.6 29.5C21.6 29.5 21.3 29.2 21.3 29.5L2.7 48C1.5 49.2 0 48.3 0 46.8C1.2 34.8 6.5 23.6 14.9 14.9Z" fill="#F05245"/> <path d="M14.9 88.8C23.4 97.4 34.7 102.7 46.8 103.7C47.6 103.8 48.3 103.3 48.4 102.5C48.5 102 48.3 101.6 48 101.2L29.5 82.4C29.2 82.4 29.5 82.1 29.5 82.4C34.8 86.2 41 88.5 47.4 89C48.3 89 48.9 87.8 48.3 87.2L35.6 74.5C35.3 74.2 35.6 74.2 35.6 74.2C39 76.5 43 78 47.1 78.4C47.7 78.4 48.3 77.5 47.7 77.2L26.1 55.6C25.5 55 24.9 55.3 24.9 56.2C25.3 60.3 26.8 64.3 29.2 67.8C29.2 67.8 28.9 68.1 28.9 67.8L16.7 55.6C15.8 55 14.6 55.3 14.9 56.5C15.5 62.9 17.8 69 21.6 74.1C21.6 74.3 21.5 74.4 21.3 74.4L2.7 55.6C2 55 0.9 55.2 0.4 55.9C0.2 56.2 0.1 56.5 0 56.9C1.1 68.9 6.4 80.2 14.9 88.8Z" fill="#1CEBCF"/> <path d="M88.1 88.8C79.6 97.5 68.3 102.8 56.2 103.7C55 104 54.1 102.2 55 101.3L73.8 82.5C73.8 82.5 73.8 82.2 73.5 82.5C68.3 86.3 62.2 88.6 55.9 89.2C55.3 89.3 54.8 88.8 54.7 88.2C54.7 87.9 54.8 87.6 55 87.3L67.8 74.5C67.8 74.2 67.8 74.2 67.5 74.2C64.1 76.6 60.1 78.1 56 78.4C55.5 78.3 55.2 77.9 55.3 77.5C55.3 77.4 55.3 77.3 55.4 77.2L77 55.6C77.6 55 78.5 55.3 78.2 56.2C77.9 60.3 76.5 64.3 74.2 67.8C73.9 67.8 74.2 68.1 74.2 67.8L86.7 55.6C87.1 55.2 87.8 55.2 88.2 55.6C88.4 55.8 88.5 56.2 88.5 56.5C87.8 62.8 85.5 68.9 81.8 74.1C81.5 74.4 81.8 74.4 81.8 74.4L100.6 55.6C101.5 54.7 103.3 55.6 103 56.8C102 68.9 96.7 80.2 88.1 88.8Z" fill="#FFE300"/> <path opacity="0.87" d="M390.8 31.9V43H388.9V31.9H385.4V30.1H394.4V31.9H390.8Z" fill="white"/> <path opacity="0.87" d="M407.7 43V34.4L404.7 40.5999H403.3L400.3 34.4V43H398.3V30.2H400.3L404 38.2L407.7 30.2H409.6V43H407.7Z" fill="white"/> </g> <defs> <clipPath id="clip0"> <rect width="409" height="104" fill="white"/> </clipPath> </defs> </svg> </div> </a> <a class="logo-text" href="https://docs.coveo.com"> <span class="logo-text-bar">|</span> <span class="logo-text-custom">docs</span> </a> </div> <div class="search"> <div id="coveoConnectHeaderStandaloneSearchbox" class="searchbox"> <div class="CoveoSearchbox" style="display: flex;" type="text" data-auto-focus="false" data-enable-omnibox="true" data-inline="false" data-enable-wildcards="true" data-enable-search-as-you-type="false" data-enable-reveal-query-suggest-addon="true" data-enable-query-syntax="true" data-enable-field-addon="true" data-placeholder="Search"></div> <div class="CoveoAnalytics"></div> </div> </div> <nav class="subnav"> <ul> <li><a href="https://connect.coveo.com/" target="_blank">Community</a></li> <li><a href="https://docs.google.com/forms/d/e/1FAIpQLSeyNL18g4JWIDR5xEyIMY48JIjyjwXRmlCveecjXBNSLh4Ygg/viewform?usp=sf_link" target="_blank">Feedback</a></li> <li><a href="https://docs.coveo.com/en/3378/">News</a></li> </ul> </nav> </div> </div> </header> <subHeader class="no-sticky"> <div class="content"> <nav class="navBar"> <ul> <li><button class="dropdownButton">Guides<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://docs.coveo.com/en/1724/">Searching With Coveo</a></li> <li><a href="https://docs.coveo.com/en/2648/">Project Guide</a></li> <li><a href="https://docs.coveo.com/en/1351/">Services</a></li> </li> </ul> </button> </li> <li> <button class="dropdownButton">API Reference<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://coveo.github.io/search-ui/" target="_blank">JavaScript Search Framework</a></li>  <li><a href="https://docs.coveo.com/en/headless/latest/reference/">Headless</a></li> <li><a href="https://docs.coveo.com/en/12/">Push API</a></li> <li><a href="https://docs.coveo.com/en/8/">Field API</a></li> <li><a href="https://docs.coveo.com/en/13/">Search API</a></li> <li><a href="https://docs.coveo.com/en/18/">Usage Analytics API</a></li> <li><a href="https://docs.coveo.com/en/4/">Other APIs</a></li> </ul> </button> </li> <li> <button class="dropdownButton">Extensions<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://docs.coveo.com/en/1499/">Coveo for Commerce</a></li> <li><a href="https://docs.coveo.com/en/1243/">Coveo for Salesforce</a></li> <li><a href="https://docs.coveo.com/en/1479/">Coveo for ServiceNow</a></li> <li><a href="https://docs.coveo.com/en/2709/">Coveo for Sitecore</a></li> </ul> </button> </li> </ul> </nav> </div> </subHeader> <div class="container container-main"> <div class="row"> <div id="toc-column" class="col-1 col-menu menu-sticky-wrap menu-highlight"> <div id="filter-box-container"> <div id="filter-box-header">Filter</div> <div id="filter-box-body"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <div class="ctr-box-filter"> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited" title="Display inherited methods and properties"> Inherited</label><br> </div> </div> </div> </div> </div> </div> <div id="filter-box-footer"></div> </div> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <a id="globals-toc-link" href=../globals.html><b>Globals</b></a> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="isearchevent.html" class="tsd-kind-icon">ISearch<wbr>Event</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#actioncause" class="tsd-kind-icon">action<wbr>Cause</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#actiontype" class="tsd-kind-icon">action<wbr>Type</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#advancedquery" class="tsd-kind-icon">advanced<wbr>Query</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#anonymous" class="tsd-kind-icon">anonymous</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#clientid" class="tsd-kind-icon">client<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#contextual" class="tsd-kind-icon">contextual</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#customdata" class="tsd-kind-icon">custom<wbr>Data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#device" class="tsd-kind-icon">device</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#didyoumean" class="tsd-kind-icon">did<wbr>You<wbr>Mean</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#facetstate" class="tsd-kind-icon">facet<wbr>State</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#language" class="tsd-kind-icon">language</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#mobile" class="tsd-kind-icon">mobile</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#numberofresults" class="tsd-kind-icon">number<wbr>OfResults</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#origincontext" class="tsd-kind-icon">origin<wbr>Context</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#originlevel1" class="tsd-kind-icon">origin<wbr>Level1</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#originlevel2" class="tsd-kind-icon">origin<wbr>Level2</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#originlevel3" class="tsd-kind-icon">origin<wbr>Level3</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#pagenumber" class="tsd-kind-icon">page<wbr>Number</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#querypipeline" class="tsd-kind-icon">query<wbr>Pipeline</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#querytext" class="tsd-kind-icon">query<wbr>Text</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#responsetime" class="tsd-kind-icon">response<wbr>Time</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#resultsperpage" class="tsd-kind-icon">results<wbr>Per<wbr>Page</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#searchqueryuid" class="tsd-kind-icon">search<wbr>Query<wbr>Uid</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#splittestrunname" class="tsd-kind-icon">split<wbr>Test<wbr>Run<wbr>Name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="isearchevent.html#splittestrunversion" class="tsd-kind-icon">split<wbr>Test<wbr>Run<wbr>Version</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#useragent" class="tsd-kind-icon">user<wbr>Agent</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#userdisplayname" class="tsd-kind-icon">user<wbr>Display<wbr>Name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#usergroups" class="tsd-kind-icon">user<wbr>Groups</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="isearchevent.html#username" class="tsd-kind-icon">username</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> <div id="separator"></div> <div class="col-2 col-content"> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <a id="home-menu-link" class="aui-nav-link" title="Go to the home page" href=..> <i class="fa fa-home" aria-hidden="true"></i> </a> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="isearchevent.html">ISearchEvent</a> </li> </ul> <h1>Interface ISearchEvent</h1> </div> </div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Describes a Coveo Cloud usage analytics <em>search</em> event.</p> </div> </div> </section> <div class="preview-container tsd-panel"> <div class="overlay"></div> </div> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#actioncause" class="tsd-kind-icon">action<wbr>Cause</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#actiontype" class="tsd-kind-icon">action<wbr>Type</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#advancedquery" class="tsd-kind-icon">advanced<wbr>Query</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#anonymous" class="tsd-kind-icon">anonymous</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#clientid" class="tsd-kind-icon">client<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#contextual" class="tsd-kind-icon">contextual</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#customdata" class="tsd-kind-icon">custom<wbr>Data</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#device" class="tsd-kind-icon">device</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#didyoumean" class="tsd-kind-icon">did<wbr>You<wbr>Mean</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#facetstate" class="tsd-kind-icon">facet<wbr>State</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#language" class="tsd-kind-icon">language</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#mobile" class="tsd-kind-icon">mobile</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#numberofresults" class="tsd-kind-icon">number<wbr>OfResults</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#origincontext" class="tsd-kind-icon">origin<wbr>Context</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#originlevel1" class="tsd-kind-icon">origin<wbr>Level1</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#originlevel2" class="tsd-kind-icon">origin<wbr>Level2</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#originlevel3" class="tsd-kind-icon">origin<wbr>Level3</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#pagenumber" class="tsd-kind-icon">page<wbr>Number</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#querypipeline" class="tsd-kind-icon">query<wbr>Pipeline</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#querytext" class="tsd-kind-icon">query<wbr>Text</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#responsetime" class="tsd-kind-icon">response<wbr>Time</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#resultsperpage" class="tsd-kind-icon">results<wbr>Per<wbr>Page</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#searchqueryuid" class="tsd-kind-icon">search<wbr>Query<wbr>Uid</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#splittestrunname" class="tsd-kind-icon">split<wbr>Test<wbr>Run<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="isearchevent.html#splittestrunversion" class="tsd-kind-icon">split<wbr>Test<wbr>Run<wbr>Version</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#useragent" class="tsd-kind-icon">user<wbr>Agent</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#userdisplayname" class="tsd-kind-icon">user<wbr>Display<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#usergroups" class="tsd-kind-icon">user<wbr>Groups</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="isearchevent.html#username" class="tsd-kind-icon">username</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="actioncause" class="tsd-anchor"></a> <h3>action<wbr>Cause</h3> <div class="tsd-signature tsd-kind-icon">action<wbr>Cause<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#actioncause">actionCause</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L20">rest/AnalyticsEvent.ts :20</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A unique name describing the action that triggered the event.</p> </div> <p>See the <a href="https://coveo.github.io/search-ui/interfaces/ianalyticsactioncause.html#name"><code>name</code></a> property of the <a href="https://coveo.github.io/search-ui/interfaces/ianalyticsactioncause.html"><code>IAnalyticsActionCause</code></a> interface.</p> <p><strong>Example:</strong> <code>pagerNext</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="actiontype" class="tsd-anchor"></a> <h3>action<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">action<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#actiontype">actionType</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L28">rest/AnalyticsEvent.ts :28</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A name describing the category of actions to which the action that triggered the event belongs.</p> </div> <p>See the <a href="https://coveo.github.io/search-ui/interfaces/ianalyticsactioncause.html#type"><code>type</code></a> property of the <a href="https://coveo.github.io/search-ui/interfaces/ianalyticsactioncause.html"><code>IAnalyticsActionCause</code></a> interface.</p> <p><strong>Example:</strong> <code>getMoreResults</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="advancedquery" class="tsd-anchor"></a> <h3>advanced<wbr>Query</h3> <div class="tsd-signature tsd-kind-icon">advanced<wbr>Query<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L63">rest/SearchEvent.ts :63</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The original advanced query expression (i.e., <code>aq</code>) sent for the related query.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related query.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="anonymous" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> anonymous</h3> <div class="tsd-signature tsd-kind-icon">anonymous<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#anonymous">anonymous</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L50">rest/AnalyticsEvent.ts :50</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the event should be logged anonymously to the Coveo Cloud usage analytics service.</p> </div> <p><strong>Note:</strong> This field is normally set to the <a href="https://coveo.github.io/search-ui/components/analytics.html#options.anonymous"><code>anonymous</code></a> option value of the <a href="https://coveo.github.io/search-ui/components/analytics.html"><code>Analytics</code></a> component.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="clientid" class="tsd-anchor"></a> <h3>client<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#clientid">clientId</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L139">rest/AnalyticsEvent.ts :139</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A GUID representing the current user. This GUID is generated locally and stored in a non-expiring browser cookie.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="contextual" class="tsd-anchor"></a> <h3>contextual</h3> <div class="tsd-signature tsd-kind-icon">contextual<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L77">rest/SearchEvent.ts :77</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the related query was contextual.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related query.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="customdata" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> custom<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">custom<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#customdata">customData</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L135">rest/AnalyticsEvent.ts :135</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Additional metadata to send along with the event.</p> </div> <p><strong>Note:</strong> This field may include custom user context information (see <a href="https://docs.coveo.com/en/399/">Sending Custom Context Information</a>).</p> <p><strong>Example:</strong> <code>{ "currentResultsPerPage": 25, "userRole": "developer" }</code></p> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="device" class="tsd-anchor"></a> <h3>device</h3> <div class="tsd-signature tsd-kind-icon">device<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#device">device</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L58">rest/AnalyticsEvent.ts :58</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The name of the device or browser that triggered the event.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by parsing the current <code>navigator.userAgent</code> value.</p> <p><strong>Example:</strong> <code>Chrome</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="didyoumean" class="tsd-anchor"></a> <h3>did<wbr>You<wbr>Mean</h3> <div class="tsd-signature tsd-kind-icon">did<wbr>You<wbr>Mean<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L71">rest/SearchEvent.ts :71</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the <em>did you mean</em> feature was enabled for the related query.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related query.</p> <p><strong>Example:</strong> <code>@source=="Product Documentation"</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="facetstate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> facet<wbr>State</h3> <div class="tsd-signature tsd-kind-icon">facet<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IAnalyticsFacetState[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L81">rest/SearchEvent.ts :81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A representation of the state of each dynamic facet in the search interface when the action that triggered the event was executed.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="language" class="tsd-anchor"></a> <h3>language</h3> <div class="tsd-signature tsd-kind-icon">language<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#language">language</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L106">rest/AnalyticsEvent.ts :106</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The language of the search interface from which the event originates.</p> </div> <p>Must be a valid <a href="https://en.wikipedia.org/wiki/ISO_639-1">ISO-639-1 code</a>.</p> <p><strong>Note:</strong> By default, the framework sets this field according to the currently loaded culture file (see <a href="https://docs.coveo.com/en/421/">Changing the Language of Your Search Interface</a>).</p> <p><strong>Example:</strong> <code>en</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="mobile" class="tsd-anchor"></a> <h3>mobile</h3> <div class="tsd-signature tsd-kind-icon">mobile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#mobile">mobile</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L64">rest/AnalyticsEvent.ts :64</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the event originates from a mobile device.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by parsing the current <code>navigator.userAgent</code> value.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="numberofresults" class="tsd-anchor"></a> <h3>number<wbr>OfResults</h3> <div class="tsd-signature tsd-kind-icon">number<wbr>OfResults<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L45">rest/SearchEvent.ts :45</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The number of query result items returned by the related query.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related Search API query response.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="origincontext" class="tsd-anchor"></a> <h3>origin<wbr>Context</h3> <div class="tsd-signature tsd-kind-icon">origin<wbr>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#origincontext">originContext</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L96">rest/AnalyticsEvent.ts :96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The broad application context from which the event originates.</p> </div> <p><strong>Note:</strong> By default, the framework sets this field to <code>Search</code>. However, you can use the <a href="https://coveo.github.io/search-ui/components/analytics.html#setorigincontext"><code>setOriginContext</code></a> method of the <a href="https://coveo.github.io/search-ui/components/analytics.html"><code>Analytics</code></a> component to modify the default value.</p> <p><strong>Example:</strong> <code>Search</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="originlevel1" class="tsd-anchor"></a> <h3>origin<wbr>Level1</h3> <div class="tsd-signature tsd-kind-icon">origin<wbr>Level1<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#originlevel1">originLevel1</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L72">rest/AnalyticsEvent.ts :72</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The identifier of the search interface from which the event originates.</p> </div> <p><strong>Note:</strong> This field is normally set through the <a href="https://coveo.github.io/search-ui/components/analytics.html#options.searchhub"><code>searchHub</code></a> option of the <a href="https://coveo.github.io/search-ui/components/analytics.html"><code>Analytics</code></a> component. However, when actually recording the event, the Coveo Cloud usage analytics service may override this value with information extracted from the search token.</p> <p><strong>Example:</strong> <code>PartnerPortalSearch</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="originlevel2" class="tsd-anchor"></a> <h3>origin<wbr>Level2</h3> <div class="tsd-signature tsd-kind-icon">origin<wbr>Level2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#originlevel2">originLevel2</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L80">rest/AnalyticsEvent.ts :80</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The identifier of the tab from which the event originates.</p> </div> <p><strong>Note:</strong> The framework normally sets this field to the identifier of the currently selected <a href="https://coveo.github.io/search-ui/components/tab.html"><code>Tab</code></a> in the search interface.</p> <p><strong>Example:</strong> <code>All</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="originlevel3" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> origin<wbr>Level3</h3> <div class="tsd-signature tsd-kind-icon">origin<wbr>Level3<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#originlevel3">originLevel3</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L88">rest/AnalyticsEvent.ts :88</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The address of the webpage that linked to the search interface from which the event originates.</p> </div> <p><strong>Note:</strong> The framework normally sets this field to the current <code>document.referrer</code> value.</p> <p><strong>Example:</strong> <code>http://example.com/</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="pagenumber" class="tsd-anchor"></a> <h3>page<wbr>Number</h3> <div class="tsd-signature tsd-kind-icon">page<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L57">rest/SearchEvent.ts :57</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The 0-based page of results requested for the related query.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related query.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="querypipeline" class="tsd-anchor"></a> <h3>query<wbr>Pipeline</h3> <div class="tsd-signature tsd-kind-icon">query<wbr>Pipeline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L15">rest/SearchEvent.ts :15</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The name of the query pipeline to which the related query was routed.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related Search API query response.</p> <p><strong>Example:</strong> <code>PartnerPortalSearchPipeline</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="querytext" class="tsd-anchor"></a> <h3>query<wbr>Text</h3> <div class="tsd-signature tsd-kind-icon">query<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L39">rest/SearchEvent.ts :39</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The original basic query expression (i.e., <code>q</code>) sent for the related query.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related query.</p> <p><strong>Example:</strong> <code>coveo machine learning</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="responsetime" class="tsd-anchor"></a> <h3>response<wbr>Time</h3> <div class="tsd-signature tsd-kind-icon">response<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#responsetime">responseTime</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L113">rest/AnalyticsEvent.ts :113</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The time it took to get a response from the Search API for the query related to the event (in milliseconds).</p> </div> <p><strong>Note:</strong> The framework normally sets this field to <code>0</code>, except for <a href="isearchevent.html">search events</a> in which case it sets the field by retrieving the information from the related Search API query response.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="resultsperpage" class="tsd-anchor"></a> <h3>results<wbr>Per<wbr>Page</h3> <div class="tsd-signature tsd-kind-icon">results<wbr>Per<wbr>Page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L51">rest/SearchEvent.ts :51</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The number of results per page requested for the related query.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related query.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="searchqueryuid" class="tsd-anchor"></a> <h3>search<wbr>Query<wbr>Uid</h3> <div class="tsd-signature tsd-kind-icon">search<wbr>Query<wbr>Uid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#searchqueryuid">searchQueryUid</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L12">rest/AnalyticsEvent.ts :12</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The unique identifier of the related query.</p> </div> <p><strong>Note:</strong> The framework normally sets this field by retrieving the information from the related Search API query response.</p> <p><strong>Example:</strong> <code>74682726-0e20-46eb-85ac-f37259346f57</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="splittestrunname" class="tsd-anchor"></a> <h3>split<wbr>Test<wbr>Run<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">split<wbr>Test<wbr>Run<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L23">rest/SearchEvent.ts :23</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The name of the A/B test that applied to the related query.</p> </div> <p><strong>Note:</strong> This field may be set through the <code>splitTestRunName</code> option of the <code>Analytics</code> component. However, if the option is left undefined, the framework attempts to set this field by retrieving information from the related Search API query response.</p> <p><strong>Example:</strong> <code>Test new ART model</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="splittestrunversion" class="tsd-anchor"></a> <h3>split<wbr>Test<wbr>Run<wbr>Version</h3> <div class="tsd-signature tsd-kind-icon">split<wbr>Test<wbr>Run<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/SearchEvent.ts#L31">rest/SearchEvent.ts :31</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The version of the A/B test that applied to the related query (i.e., version A or version B).</p> </div> <p><strong>Note:</strong> This field may be set through the <code>splitTestRunVersion</code> option of the <code>Analytics</code> component. However, if the option is left undefined and the related Search API query response indicates that an A/B test was applied, the framework sets this field to the name of the query pipeline to which the query was routed.</p> <p><strong>Example:</strong> <code>PartnerPortalSearchPipelineWithART</code></p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="useragent" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Agent</h3> <div class="tsd-signature tsd-kind-icon">user<wbr>Agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="ianalyticsevent.html">IAnalyticsEvent</a>.<a href="ianalyticsevent.html#useragent">userAgent</a></p> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/AnalyticsEvent.ts#L121">rest/AnalyticsEvent.ts :121</a></li> </ul> </aside> <div class="tsd-comment tsd-typ