ui_
The  event logs occurrences when an extension fails to render due to an uncaught exception in the extension code.
This event is only available on checkout.
Anchor to propertiesProperties
- Anchor to clientIdclientIdstring
- The client-side ID of the customer, provided by Shopify 
- Anchor to contextcontextContext
- Anchor to datadataPixelEventsUiExtensionErroredData
- string
- The ID of the customer event 
- Anchor to namenamestring
- The name of the customer event 
- number
- The sequence index number of the event. 
- Anchor to timestamptimestampstring
- The timestamp of when the customer event occurred, in ISO 8601 format 
- Anchor to typetypeEventType.Standard
Context
A snapshot of various read-only properties of the browser at the time of event
- documentSnapshot of a subset of properties of the `document` object in the top frame of the browser WebPixelsDocument
- navigatorSnapshot of a subset of properties of the `navigator` object in the top frame of the browser WebPixelsNavigator
- windowSnapshot of a subset of properties of the `window` object in the top frame of the browser WebPixelsWindow
export interface Context {
  /**
   * Snapshot of a subset of properties of the `document` object in the top
   * frame of the browser
   */
  document?: WebPixelsDocument;
  /**
   * Snapshot of a subset of properties of the `navigator` object in the top
   * frame of the browser
   */
  navigator?: WebPixelsNavigator;
  /**
   * Snapshot of a subset of properties of the `window` object in the top frame
   * of the browser
   */
  window?: WebPixelsWindow;
}WebPixelsDocument
A snapshot of a subset of properties of the `document` object in the top frame of the browser
- characterSetPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the character set being used by the document string
- locationPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the current document Location
- referrerPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the page that linked to this page string
- titlePer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the title of the current document string
export interface WebPixelsDocument {
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document),
   * returns the character set being used by the document
   */
  characterSet?: string;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document),
   * returns the URI of the current document
   */
  location?: Location;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document),
   * returns the URI of the page that linked to this page
   */
  referrer?: string;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document),
   * returns the title of the current document
   */
  title?: string;
}Location
A snapshot of a subset of properties of the `location` object in the top frame of the browser
- hashPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'#'` followed by the fragment identifier of the URL string
- hostPer [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 string
- hostnamePer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the domain of the URL string
- hrefPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the entire URL string
- originPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the canonical form of the origin of the specific location string
- pathnamePer [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 string
- portPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the port number of the URL string
- protocolPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the protocol scheme of the URL, including the final `':'` string
- searchPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'?'` followed by the parameters or "querystring" of the URL string
export interface Location {
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a
   * string containing a `'#'` followed by the fragment identifier of the URL
   */
  hash?: string;
  /**
   * 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
   */
  host?: string;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a
   * string containing the domain of the URL
   */
  hostname?: string;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a
   * string containing the entire URL
   */
  href?: string;
  /**
   * 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
   */
  origin?: string;
  /**
   * 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
   */
  pathname?: string;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a
   * string containing the port number of the URL
   */
  port?: string;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a
   * string containing the protocol scheme of the URL, including the final `':'`
   */
  protocol?: string;
  /**
   * 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
   */
  search?: string;
}WebPixelsNavigator
A snapshot of a subset of properties of the `navigator` object in the top frame of the browser
- cookieEnabledPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns `false` if setting a cookie will be ignored and true otherwise boolean
- languagePer [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 string
- languagesPer [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 ReadonlyArray<string>
- userAgentPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns the user agent string for the current browser string
export interface WebPixelsNavigator {
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator),
   * returns `false` if setting a cookie will be ignored and true otherwise
   */
  cookieEnabled?: boolean;
  /**
   * 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
   */
  language?: string;
  /**
   * 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
   */
  languages?: ReadonlyArray<string>;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator),
   * returns the user agent string for the current browser
   */
  userAgent?: string;
}WebPixelsWindow
A snapshot of a subset of properties of the `window` object in the top frame of the browser
- innerHeightPer [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 number
- innerWidthPer [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 number
- locationPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the location, or current URL, of the window object Location
- originPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the global object's origin, serialized as a string string
- outerHeightPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the height of the outside of the browser window number
- outerWidthPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the width of the outside of the browser window number
- pageXOffsetPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollX number
- pageYOffsetPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollY number
- screenPer [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 Screen
- screenXPer [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 number
- screenYPer [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 number
- scrollXPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled horizontally number
- scrollYPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled vertically number
export interface WebPixelsWindow {
  /**
   * 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
   */
  innerHeight?: number;
  /**
   * 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
   */
  innerWidth?: number;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the
   * location, or current URL, of the window object
   */
  location?: Location;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the
   * global object's origin, serialized as a string
   */
  origin?: string;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets
   * the height of the outside of the browser window
   */
  outerHeight?: number;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets
   * the width of the outside of the browser window
   */
  outerWidth?: number;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an
   * alias for window.scrollX
   */
  pageXOffset?: number;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an
   * alias for window.scrollY
   */
  pageYOffset?: number;
  /**
   * 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
   */
  screen?: Screen;
  /**
   * 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
   */
  screenX?: number;
  /**
   * 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
   */
  screenY?: number;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the
   * number of pixels that the document has already been scrolled horizontally
   */
  scrollX?: number;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the
   * number of pixels that the document has already been scrolled vertically
   */
  scrollY?: number;
}Screen
The interface representing a screen, usually the one on which the current window is being rendered
- heightPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/height), the height of the screen number
- widthPer [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/width), the width of the screen number
export interface Screen {
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/height),
   * the height of the screen
   */
  height?: number;
  /**
   * Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/width),
   * the width of the screen
   */
  width?: number;
}PixelEventsUiExtensionErroredData
- errorUiExtensionError
export interface PixelEventsUiExtensionErroredData {
  error?: UiExtensionError;
}UiExtensionError
An object that contains data about a UI Extension error that occurred.
- apiVersionThe API version used by the extension. string
- appIdThe unique identifier of the app that the extension belongs to. string
- appNameThe name of the app that the extension belongs to. string
- appVersionThe version of the app that encountered the error. string
- extensionNameThe name of the extension that encountered the error. string
- extensionTargetThe [target](https://shopify.dev/docs/api/checkout-ui-extensions/latest/targets) of the extension, for example "purchase.checkout.delivery-address.render-after". string
- messageThe message associated with the error that occurred. string
- placementReferenceThe [placement reference](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#dynamic-targets) of the extension, only populated for dynamic targets. string | null
- traceThe stack trace associated with the error that occurred. string
- typeThe type of error that occurred. UiExtensionErrorType
export interface UiExtensionError {
  /**
   * The API version used by the extension.
   */
  apiVersion?: string;
  /**
   * The unique identifier of the app that the extension belongs to.
   */
  appId?: string;
  /**
   * The name of the app that the extension belongs to.
   */
  appName?: string;
  /**
   * The version of the app that encountered the error.
   */
  appVersion?: string;
  /**
   * The name of the extension that encountered the error.
   */
  extensionName?: string;
  /**
   * The [target](https://shopify.dev/docs/api/checkout-ui-extensions/latest/targets) of the extension, for example
   * "purchase.checkout.delivery-address.render-after".
   */
  extensionTarget?: string;
  /**
   * The message associated with the error that occurred.
   */
  message?: string;
  /**
   * The [placement reference](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#dynamic-targets) of the extension, only populated
   * for dynamic targets.
   */
  placementReference?: string | null;
  /**
   * The stack trace associated with the error that occurred.
   */
  trace?: string;
  /**
   * The type of error that occurred.
   */
  type?: UiExtensionErrorType;
}UiExtensionErrorType
- ExtensionUsageErrorEXTENSION_USAGE_ERROR
export enum UiExtensionErrorType {
  /**
   * An error caused by incorrect usage of extension APIs or UI components.
   */
  ExtensionUsageError = 'EXTENSION_USAGE_ERROR',
}EventType
- AdvancedDomadvanced-dom
- Customcustom
- Domdom
- Metameta
- Standardstandard
export enum EventType {
  AdvancedDom = 'advanced-dom',
  Custom = 'custom',
  Dom = 'dom',
  Meta = 'meta',
  Standard = 'standard',
}Accessing Standard Events
Examples
- Accessing Standard Events- App Pixel- import {register} from '@shopify/web-pixels-extension'; register(({analytics}) => { analytics.subscribe('ui_extension_errored', (event) => { // Example for accessing event data const {apiVersion, appId, appName, appVersion, trace} = event.data.alert; const payload = { event_name: event.name, event_data: { apiVersion, appId, appName, appVersion, trace, }, }; // Example for sending event data to third party servers fetch('https://example.com/pixel', { method: 'POST', body: JSON.stringify(payload), keepalive: true, }); }); });- Custom Pixel- analytics.subscribe('ui_extension_errored', (event) => { // Example for accessing event data const {apiVersion, appId, appName, appVersion, trace} = event.data.alert; const payload = { event_name: event.name, event_data: { apiVersion, appId, appName, appVersion, trace, }, }; // Example for sending event to third party servers fetch('https://example.com/pixel', { method: 'POST', body: JSON.stringify(payload), keepalive: true, }); });