Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

Choose a version:

Analytics API

The Analytics API lets you publish custom events and visitor information to web pixels configured on the store. Use this API to track customer behavior in your extension and send conversion data to third-party analytics services.

Anchor to Use casesUse cases

Track extension interactions: Publish custom events when customers interact with your extension, such as viewing a product recommendation or clicking a promotion banner.
Measure conversions: Send conversion events from customer account pages to analytics platforms for attribution and reporting.
Identify returning visitors: Submit visitor contact information so downstream analytics tools can associate sessions with known customers.

Support

Targets (25)

Supported targets

Anchor to PropertiesProperties

The Analytics API object provides the analytics interface for customer account extensions. Access the following properties on the API object to publish custom events and send visitor data to web pixels.

Anchor to analytics analytics required: Methods for interacting with web pixels, such as publishing analytics events.

Note
Requires a connected third-party domain for your customer account pages.
Note: Requires a <a href="https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account">connected third-party domain</a> for your customer account pages.

Analytics

Methods for interacting with [web pixels](/docs/apps/build/marketing-analytics/pixels), including publishing analytics events and capturing visitor identity data.

publish
Publishes analytics events to [web pixels](/docs/apps/build/marketing-analytics/pixels). Events are forwarded to all subscribed pixels.
```
(name: string, data: Record<string, unknown>) => Promise<boolean>
```
visitor
Captures visitor identity data (email or phone) for analytics and marketing attribution.
```
(data: { email?: string; phone?: string; }) => Promise<VisitorResult>
```

VisitorResult

Represents a visitor result.

VisitorSuccess | VisitorError

VisitorSuccess

Represents a successful visitor result.

type
Indicates the visitor information was successfully validated and submitted.
```
'success'
```

VisitorError

Represents an unsuccessful visitor result.

message
A message that explains the error. This message is useful for debugging. It's **not** localized, and therefore should not be presented directly to the buyer.
```
string
```
type
Indicates the visitor information was invalid and wasn't submitted, such as using an incorrect data type or missing a required property.
```
'error'
```

Examples

import {

Banner,

reactExtension,

useApi,

} from '@shopify/ui-extensions-react/customer-account';

export default reactExtension(

'customer-account.order-status.block.render',

() => <Extension />,

);

function Extension() {

const {analytics} = useApi();

analytics

.publish(

'customer-account-extension-loaded',

{

extensionName: 'My Extension',

)

.then((result) => {

if (result) {

console.log(

'successfully published event, web pixels can now receive this event',

);

} else {

console.log('failed to publish event');

}

})

.catch((error) => {

console.log('failed to publish event');

console.log('error', error);

});

return <Banner>See console for result</Banner>;

}

Examples

Publish a custom analytics event

Description

Publish a custom event to all web pixels configured on the store. This example fires a `customer-account-extension-loaded` event when the extension mounts and logs whether the publish succeeded.

React

import {
  Banner,
  reactExtension,
  useApi,
} from '@shopify/ui-extensions-react/customer-account';

export default reactExtension(
  'customer-account.order-status.block.render',
  () => <Extension />,
);

function Extension() {
  const {analytics} = useApi();

  analytics
    .publish(
      'customer-account-extension-loaded',
      {
        extensionName: 'My Extension',
      },
    )
    .then((result) => {
      if (result) {
        console.log(
          'successfully published event, web pixels can now receive this event',
        );
      } else {
        console.log('failed to publish event');
      }
    })
    .catch((error) => {
      console.log('failed to publish event');
      console.log('error', error);
    });

  return <Banner>See console for result</Banner>;
}

TS

import {
  extension,
  Banner,
} from '@shopify/ui-extensions/customer-account';

export default extension(
  'customer-account.order-status.block.render',
  (root, {analytics}) => {
    analytics
      .publish(
        'customer-account-extension-loaded',
        {
          extensionName: 'My Extension',
        },
      )
      .then((result) => {
        if (result) {
          console.log(
            'successfully published event, web pixels can now receive this event',
          );
        } else {
          console.log('failed to publish event');
        }
      })
      .catch((error) => {
        console.error('failed to publish event');
        console.error('error', error);
      });

    root.appendChild(
      root.createComponent(
        Banner,
        {},
        'See console for result',
      ),
    );
  },
);

Submit visitor information

Description

Send visitor contact details to the store backend for identity resolution. This example submits an email and phone number and handles the success or error response.

React

import {
  Banner,
  reactExtension,
  useApi,
} from '@shopify/ui-extensions-react/customer-account';

export default reactExtension(
  'customer-account.order-status.block.render',
  () => <Extension />,
);

function Extension() {
  const {analytics} = useApi();

  analytics
    .visitor({
      email: 'someEmail@example.com',
      phone: '+1 555 555 5555',
    })
    .then((result) => {
      if (result.type === 'success') {
        console.log('Success', result);
      } else {
        console.error('Error', result);
      }
    });

  return <Banner>See console for result</Banner>;
}

TS

import {
  extension,
  Banner,
} from '@shopify/ui-extensions/customer-account';

export default extension(
  'customer-account.order-status.block.render',
  (root, {analytics}) => {
    analytics
      .visitor({
        email: 'someEmail@example.com',
        phone: '+1 555 555 5555',
      })
      .then((result) => {
        if (result.type === 'success') {
          console.log('Success', result);
        } else {
          console.error('Error', result);
        }
      });

    root.appendChild(
      root.createComponent(
        Banner,
        {},
        'See console for result',
      ),
    );
  },
);

Anchor to Best practicesBest practices

Publish events inside useEffect: Trigger analytics calls after the component mounts so you don't block the initial render.
Handle publish failures gracefully: Always attach a .catch() handler to shopify.analytics.publish() so undelivered events don't cause uncaught promise rejections.
Use descriptive event names: Choose event names that clearly identify the interaction, such as loyalty-points-redeemed or subscription-upgraded, so pixel consumers can filter and act on them.
Avoid sending sensitive data in event payloads: Don't include passwords, full payment details, or other personally identifiable information beyond what's needed for analytics.

Anchor to LimitationsLimitations

Custom events published through this API are only delivered to web pixels that are configured on the store. If no pixels are active, the publish call resolves but has no downstream effect.
The shopify.analytics.visitor() method sends data to the store backend only. Visitor information isn't propagated to web pixels on the page.
Event payloads must be JSON-serializable. Functions, DOM nodes, and circular references can't be included.

Was this page helpful?