# search_submitted The `search_submitted` event logs an instance where a customer performed a search on the storefront. The products returned from the search query are in this event object (the first product variant for each product is listed in the array). This event is available on the online store page. ### Accessing Standard Events ```javascript import {register} from '@shopify/web-pixels-extension'; register(({analytics}) => { analytics.subscribe('search_submitted', (event) => { // Example for accessing event data const searchResult = event.data.searchResult; const searchQuery = searchResult.query; const firstProductReturnedFromSearch = searchResult.productVariants[0]?.product.title; const payload = { event_name: event.name, event_data: { searchQuery: searchQuery, firstProductTitle: firstProductReturnedFromSearch, }, }; // Example for sending event to third party servers fetch('https://example.com/pixel', { method: 'POST', body: JSON.stringify(payload), keepalive: true, }); }); }); ``` ```javascript analytics.subscribe('search_submitted', (event) => { // Example for accessing event data const searchResult = event.data.searchResult; const searchQuery = searchResult.query; const firstProductReturnedFromSearch = searchResult.productVariants[0]?.product.title; const payload = { event_name: event.name, event_data: { searchQuery: searchQuery, firstProductTitle: firstProductReturnedFromSearch, }, }; // Example for sending event to third party servers fetch('https://example.com/pixel', { method: 'POST', body: JSON.stringify(payload), keepalive: true, }); }); ``` ## Properties ### PixelEventsSearchSubmitted The `search_submitted` event logs an instance where a customer performed a search on the storefront. This event is available on the online store page ### clientId The client-side ID of the customer, provided by Shopify ### context ### data ### id The ID of the customer event ### name The name of the customer event ### seq The sequence index number of the event. ### timestamp The timestamp of when the customer event occurred, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format ### type ### Context A snapshot of various read-only properties of the browser at the time of event ### document Snapshot of a subset of properties of the `document` object in the top frame of the browser ### navigator Snapshot of a subset of properties of the `navigator` object in the top frame of the browser ### window Snapshot of a subset of properties of the `window` object in the top frame of the browser ### WebPixelsDocument A snapshot of a subset of properties of the `document` object in the top frame of the browser ### characterSet Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the character set being used by the document ### location Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the current document ### referrer Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the page that linked to this page ### title Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the title of the current document ### Location A snapshot of a subset of properties of the `location` object in the top frame of the browser ### hash Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'#'` followed by the fragment identifier of the URL ### host Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the host, that is the hostname, a `':'`, and the port of the URL ### hostname Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the domain of the URL ### href Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the entire URL ### origin Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the canonical form of the origin of the specific location ### pathname Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing an initial `'/'` followed by the path of the URL, not including the query string or fragment ### port Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the port number of the URL ### protocol Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the protocol scheme of the URL, including the final `':'` ### search Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'?'` followed by the parameters or "querystring" of the URL ### WebPixelsNavigator A snapshot of a subset of properties of the `navigator` object in the top frame of the browser ### cookieEnabled Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns `false` if setting a cookie will be ignored and true otherwise ### language Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns a string representing the preferred language of the user, usually the language of the browser UI. The `null` value is returned when this is unknown ### languages Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns an array of strings representing the languages known to the user, by order of preference ### userAgent Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns the user agent string for the current browser ### WebPixelsWindow A snapshot of a subset of properties of the `window` object in the top frame of the browser ### innerHeight Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the height of the content area of the browser window including, if rendered, the horizontal scrollbar ### innerWidth Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the width of the content area of the browser window including, if rendered, the vertical scrollbar ### location Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the location, or current URL, of the window object ### origin Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the global object's origin, serialized as a string ### outerHeight Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the height of the outside of the browser window ### outerWidth Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the width of the outside of the browser window ### pageXOffset Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollX ### pageYOffset Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollY ### screen Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen), the interface representing a screen, usually the one on which the current window is being rendered ### screenX Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the horizontal distance from the left border of the user's browser viewport to the left side of the screen ### screenY Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the vertical distance from the top border of the user's browser viewport to the top side of the screen ### scrollX Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled horizontally ### scrollY Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled vertically ### Screen The interface representing a screen, usually the one on which the current window is being rendered ### height Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/height), the height of the screen ### width Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/width), the width of the screen ### PixelEventsSearchSubmittedData ### searchResult ### SearchResult An object that contains the metadata of when a search has been performed. ### productVariants ### query The search query that was executed ### ProductVariant A product variant represents a different version of a product, such as differing sizes or differing colors. ### id A globally unique identifier. ### image Image associated with the product variant. This field falls back to the product image if no image is available. ### price The product variant’s price. ### product The product object that the product variant belongs to. ### sku The SKU (stock keeping unit) associated with the variant. ### title The product variant’s title. ### untranslatedTitle The product variant’s untranslated title. ### Image An image resource. ### src The location of the image as a URL. ### MoneyV2 A monetary value with currency. ### amount The decimal money amount. ### currencyCode The three-letter code that represents the currency, for example, USD. Supported codes include standard ISO 4217 codes, legacy codes, and non- standard codes. ### Product A product is an individual item for sale in a Shopify store. ### id The ID of the product. ### title The product’s title. ### type The [product type](https://help.shopify.com/en/manual/products/details/product-type) specified by the merchant. ### untranslatedTitle The product’s untranslated title. ### url The relative URL of the product. ### vendor The product’s vendor name. ### EventType ### AdvancedDom ### Custom ### Dom ### Standard