---
title: useAnalytics
slug: oms/n6Gx-useanalytics
docTags: 
createdAt: 2022-11-09T15:25:54.000Z
---

The `useAnalytics` hook returns a series of methods that fire a tracking event to Segment, our integrated customer data platform.

Most Segment tracking is done automatically by the SDK. For example, when you use the `addToCart` method (see `useCart`), a corresponding `track` API call to Segment is made. However, some `track` calls need to be closely tied to the UI, as in the case of tracking clicks on elements, and these calls need to be explicitly made from your React components. Methods for making these calls are available via the `useAnalytics` hook and listed below.

::::CodeDrawer{title="useAnalytics" isResponseExpanded="false" autoGeneratedAnchorSlug="useanalytics" legacyHash="FydRaZPDRErpa6ANgxS5I"}
:::CodeblockTabsExamples
```javascript
import { useAnalytics } from '@chordcommerce/gatsby-theme-performance'

const {
  trackCartViewed,
  trackCollectionClicked,
  trackEmailCaptured,
  trackProductClicked,
  trackProductListFiltered,
  trackProductListViewed,
  trackProductViewed,
  trackPromotionClicked,
  trackPromotionViewed,
  trackStockRequestCreated
} = useAnalytics()
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackCartViewed()

Results in a `Cart Viewed` `track`event in Segment.

**Example:**

::::CodeDrawer{title="trackCartViewed" isResponseExpanded="false" autoGeneratedAnchorSlug="trackcartviewed-1" legacyHash="8XsEeqWzcqXtxTpKfX742"}
:::CodeblockTabsExamples
```javascript
trackCartViewed()
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackCollectionClicked()

Results in a `Collection Clicked` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackCollectionClicked" isResponseExpanded="false" autoGeneratedAnchorSlug="trackcollectionclicked-1" legacyHash="9ZPCJzsTmBGkbQZzdYDws"}
:::CodeblockTabsExamples
```javascript
trackCollectionClicked({ id, description, imageUrl, slug, title })
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackEmailCaptured()

Results in a `Email Captured` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackEmailCaptured" isResponseExpanded="false" autoGeneratedAnchorSlug="trackemailcaptured-1" legacyHash="wuSi0RKiTOc3c6GkMhHBI"}
:::CodeblockTabsExamples
```javascript
trackEmailCaptured({ 
    email: 'test@test.com', 
    placement: 'footer'
})
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackProductClicked()

Results in a `Product Clicked` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackProductClicked" isResponseExpanded="false" autoGeneratedAnchorSlug="trackproductclicked-1" legacyHash="RMsH-3aBwKpRj07WKQyvl"}
:::CodeblockTabsExamples
```javascript
trackProductClicked({ productHandle: 'product-1' })
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackProductListFiltered()

Results in a `Product List Filtered` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackProductListFiltered" isResponseExpanded="false" autoGeneratedAnchorSlug="trackproductlistfiltered-1" legacyHash="5PmN1r4M7TJWXgx38yG2X"}
:::CodeblockTabsExamples
```javascript
trackProductListFiltered({ 
    filter: {
        type: 'color',
        value: 'red'
    },
    list: {
        category: 'shirt',
        id: '123'
    }, 
    sort: {
        type: 'ascending',
        value: 'price'
    }
})
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackProductListViewed()

Results in a `Product List Viewed` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackProductListViewed" isResponseExpanded="false" autoGeneratedAnchorSlug="trackproductlistviewed-1" legacyHash="Tr40hzvccojeon6k69I0q"}
:::CodeblockTabsExamples
```javascript
trackProductListViewed({ 
    list: {
        category: 'shirt',
        id: '123'
    }
})
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackProductViewed()

Results in a `Product Viewed` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackProductViewed" isResponseExpanded="false" autoGeneratedAnchorSlug="trackproductviewed-1" legacyHash="waibas-bydT3mOuhs1EHx"}
:::CodeblockTabsExamples
```javascript
trackProductViewed({ productHandle: 'product-1' })
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackPromotionClicked()

Results in a `Promotion Clicked` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackPromotionClicked" isResponseExpanded="false" autoGeneratedAnchorSlug="trackpromotionclicked-1" legacyHash="8E0iOm8M4olSz0TPJQrOF"}
:::CodeblockTabsExamples
```javascript
trackPromotionClicked({
    creative: 'apple',
    id: '123',
    name: 'red-shirt-sale',
    position: 'banner'
})
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackPromotionViewed()

Results in a `Promotion Viewed` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackPromotionClicked" isResponseExpanded="false" autoGeneratedAnchorSlug="trackpromotionclicked-2" legacyHash="ph2wwK_mT0h5H_pIsDc4M"}
:::CodeblockTabsExamples
```javascript
trackPromotionClicked({
    creative: 'apple',
    id: '123',
    name: 'red-shirt-sale',
    position: 'banner'
})
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::

### trackStockRequestCreated()

Results in a `Stock Request Created` `track` event in Segment.

**Example:**

::::CodeDrawer{title="trackStockRequestCreated" isResponseExpanded="false" autoGeneratedAnchorSlug="trackstockrequestcreated-1" legacyHash="wsbGxLYmXYF-6vl7x1q7X"}
:::CodeblockTabsExamples
```javascript
trackStockRequestCreated({
    email: 'test@test.com'.
    productHandle: 'product-1'
})
```
:::

:::CodeblockTabsResponses
```javascript
```
:::
::::