advanced_dom_window_resized
interface

Requires access to the Advanced DOM Events in web pixel app extensions scope. To request access, please use the form in the Partner Dashboard. This scope is only available for apps that have a heatmap and/or session recordings. The Advanced DOM Events cannot be used on custom apps.

The advanced_dom_window_resized event is published when a customer resizes their browser window.

Shopify Plus

This event is limited on checkout to stores on the Shopify Plus plan.

Anchor to propertiesProperties

Anchor to clientId clientId string: The client-side ID of the customer, provided by Shopify
Anchor to data data: No additional data is provided by design. Use the event context to get the latest window size.
Anchor to id id string: The ID of the customer event
Anchor to name name string: The name of the customer event.
Anchor to seq seq number: The sequence index number of the event.
Anchor to timestamp timestamp string: The timestamp of when the customer event occurred, in ISO 8601 format
Anchor to type type .AdvancedDom

PixelEventsAdvancedDomWindowResized

The `advanced_dom_window_resized` event logs an instance where the browser window has been resized.

clientId
The client-side ID of the customer, provided by Shopify
```
string
```
data
No additional data is provided by design. Use the event context to get the latest window size.
```
PixelEventsAdvancedDomWindowResizedData
```
id
The ID of the customer event
```
string
```
name
The name of the customer event.
```
string
```
seq
The sequence index number of the event.
```
number
```
timestamp
The timestamp of when the customer event occurred, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
```
string
```
type
```
EventType.AdvancedDom
```

export interface PixelEventsAdvancedDomWindowResized {
  /**
   * The client-side ID of the customer, provided by Shopify
   */
  clientId?: string;

  /**
   * No additional data is provided by design. Use the event context to get the
   * latest window size.
   */
  data?: PixelEventsAdvancedDomWindowResizedData;
  /**
   * The ID of the customer event
   */
  id?: string;

  /**
   * The name of the customer event.
   */
  name?: string;

  /**
   * The sequence index number of the event.
   */
  seq?: number;
  /**
   * The timestamp of when the customer event occurred, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
   */
  timestamp?: string;
  type?: EventType.AdvancedDom;
}

PixelEventsAdvancedDomWindowResizedData

No additional data is provided by design. Use the event context to get the latest window size.

export interface PixelEventsAdvancedDomWindowResizedData {}

EventType

AdvancedDom
```
advanced-dom
```
Custom
```
custom
```
Dom
```
dom
```
Meta
```
meta
```
Standard
```
standard
```

export enum EventType {
  AdvancedDom = 'advanced-dom',
  Custom = 'custom',
  Dom = 'dom',
  Meta = 'meta',
  Standard = 'standard',
}

Was this section helpful?

Accessing Advanced DOM Events

App Pixel

import {register} from '@shopify/web-pixels-extension';

analytics.subscribe('advanced_dom_window_resized', (event) => {

// Accessing event payload

const payload = {

event_name: event.name,

event_data: {

width: event.context.window.innerWidth,

height: event.context.window.innerHeight,

};

// E.g. sending event to third party servers

fetch('https://example.com/pixel', {

method: 'POST',

body: JSON.stringify(payload),

keepalive: true,

});

examples

Accessing Advanced DOM Events

App Pixel

import {register} from '@shopify/web-pixels-extension';

register(({analytics}) => {
  analytics.subscribe('advanced_dom_window_resized', (event) => {
    // Accessing event payload
    const payload = {
      event_name: event.name,
      event_data: {
        width: event.context.window.innerWidth,
        height: event.context.window.innerHeight,
      },
    };

    // E.g. sending event to third party servers
    fetch('https://example.com/pixel', {
      method: 'POST',
      body: JSON.stringify(payload),
      keepalive: true,
    });
  });
});

advanced_dom_window_resizedinterface

Anchor to propertiesProperties

PixelEventsAdvancedDomWindowResized

PixelEventsAdvancedDomWindowResizedData

EventType

examples

Accessing Advanced DOM Events

App Pixel

advanced_dom_window_resized
interface