Analytics

Events dispatch through consent-derived sinks, so firing one is always safe, and you never check consent first. Each event takes a typed payload (CartLineData, CheckoutStartedData, and so on). A custom sink registered with useAnalyticsSink receives the same payloads and implements every event, as a no-op if it has no use for one.

`analytics/analytics-provider`

@replohq/sdk/analytics/analytics-provider

`useAnalytics`

Returns the AnalyticsSink from the nearest AnalyticsProvider. Throws if used outside of an AnalyticsProvider.

import { useAnalytics } from "@replohq/sdk/analytics/analytics-provider";

useAnalytics: () => AnalyticsSink

`useAnalyticsOptional`

Returns the AnalyticsSink if an AnalyticsProvider is present, or null otherwise. Does not throw — safe to use in components that may render with or without analytics.

import { useAnalyticsOptional } from "@replohq/sdk/analytics/analytics-provider";

useAnalyticsOptional: () => AnalyticsSink | null

`useAnalyticsSink`

import { useAnalyticsSink } from "@replohq/sdk/analytics/analytics-provider";

useAnalyticsSink: (sink: AnalyticsSink) => void

Also exported

Export	Kind	Type
`AnalyticsProvider`	component	`({ children, checkoutProvider, }: React.PropsWithChildren<{ checkoutProvider?: CheckoutProvider; }>) => JSX.Element`

`analytics/analytics-sink`

@replohq/sdk/analytics/analytics-sink

`AnalyticsProductLine`

One product line on a product, cart, collection or checkout event. Prices are decimal major units (19.99), never integer minor units.

import type { AnalyticsProductLine } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required	Description
`currency`	`string`	No
`price`	`number`	No
`productId`	`string`	Yes
`productTitle`	`string`	No
`quantity`	`number`	No
`variantId`	`string`	No
`variantSku`	`string`	No	May be empty when the variant has no SKU.
`variantTitle`	`string`	No

`AnalyticsSink`

What useAnalytics() returns, and what every sink implements, including sinks registered with useAnalyticsSink. Each event takes its typed payload; a sink with no use for an event implements it as a no-op.

import type { AnalyticsSink } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required	Description
`addToCart`	`(payload: CartLineEventPayload) => Promise<void>`	Yes
`click`	`(payload: ClickPayload) => Promise<void>`	Yes
`customEvent`	`(payload: CustomEventPayload) => Promise<void>`	Yes	An explicit business goal, such as a completed quiz.
`pageView`	`(metadata?: PageMetadata) => Promise<void>`	Yes
`productViewed`	`(payload: ProductViewedPayload) => Promise<void>`	Yes
`purchase`	`(payload: PurchasePayload) => Promise<void>`	Yes
`removeFromCart`	`(payload: CartLineEventPayload) => Promise<void>`	Yes
`startCheckout`	`(payload: CheckoutStartedPayload \| LegacyCheckoutStartedPayload) => Promise<void>`	Yes	Also takes the nested payload older starter carts send; the built-in sinks convert it to `CheckoutStartedData`.
`viewCart`	`(payload: CartViewedPayload) => Promise<void>`	Yes
`viewCollection`	`(payload: CollectionViewedPayload) => Promise<void>`	Yes

`CartLineData`

Sent by the cart provider for each added or removed line.

import type { CartLineData } from "@replohq/sdk/analytics/analytics-sink";

CartLineData: AnalyticsProductLine & { quantity: number; }

`CartViewedData`

Sent by the cart provider when the cart opens.

import type { CartViewedData } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required
`currency`	`string`	No
`itemCount`	`number`	Yes
`lineItems`	`CartLineData[]`	Yes
`subtotal`	`number`	Yes

`CheckoutStartedData`

The cart a shopper takes to checkout, with its order total.

import type { CheckoutStartedData } from "@replohq/sdk/analytics/analytics-sink";

CheckoutStartedData: CartViewedData & { total: number; }

`ClickData`

A site-defined click; its properties are forwarded as-is.

import type { ClickData } from "@replohq/sdk/analytics/analytics-sink";

ClickData: { [x: string]: AnalyticsProperty; }

`CollectionViewedData`

Sent by useCollectionViewedAnalytics.

import type { CollectionViewedData } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required
`collectionHandle`	`string`	No
`collectionId`	`string`	Yes
`collectionTitle`	`string`	No
`currency`	`string`	No
`products`	`AnalyticsProductLine[]`	Yes

`LegacyCheckoutLineItem`

A checkout line as older starter carts built it.

import type { LegacyCheckoutLineItem } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required
`finalLinePrice`	`LegacyMoney`	No
`id`	`string`	Yes
`quantity`	`number`	Yes
`title`	`string`	Yes
`variant`	`{ id: string; title: string; price: LegacyMoney; product: { id: string; title: string; url?: string; }; }`	Yes

`LegacyCheckoutStartedData`

The nested checkout payload older starter carts send.

import type { LegacyCheckoutStartedData } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required
`currencyCode`	`string`	Yes
`lineItems`	`LegacyCheckoutLineItem[]`	Yes
`subtotalPrice`	`LegacyMoney`	Yes
`totalPrice`	`LegacyMoney`	Yes

`LegacyMoney`

A money amount as older starter carts built it.

import type { LegacyMoney } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required	Description
`amount`	`number`	Yes
`currencyCode`	`string`	Yes

`ProductViewedData`

Sent by useProductViewedAnalytics.

import type { ProductViewedData } from "@replohq/sdk/analytics/analytics-sink";

ProductViewedData: Omit<AnalyticsProductLine, "quantity"> & { productSlug?: string; productDescription?: string; }

`PurchaseData`

Order amounts are decimal major units, like PurchasePayload.amount.

import type { PurchaseData } from "@replohq/sdk/analytics/analytics-sink";

Field	Type	Required	Description
`discountCodes`	`string[]`	No
`itemCount`	`number`	No	Units in the order, when the caller has a count but no lines.
`lineItems`	`CartLineData[]`	No
`orderId`	`string`	No
`totalDiscount`	`number`	No
`totalShipping`	`number`	No
`totalTax`	`number`	No

Also exported

Export	Kind	Type
`AnalyticsProperty`	type	`string \| number \| boolean \| AnalyticsProperty[] \| { [key: string]: AnalyticsProperty; }`
`CartLineEventPayload`	type	`{ data: CartLineData; }`
`CartViewedPayload`	type	`{ data: CartViewedData; }`
`CheckoutStartedPayload`	type	`{ data: CheckoutStartedData; }`
`ClickPayload`	type	`{ data: ClickData; }`
`CollectionViewedPayload`	type	`{ data: CollectionViewedData; }`
`CustomEventPayload`	type	`{ event: string; properties?: Record<string, AnalyticsProperty> }`
`LegacyCheckoutStartedPayload`	type	`{ data: LegacyCheckoutStartedData; }`
`ProductViewedPayload`	type	`{ data: ProductViewedData; }`
`PurchasePayload`	type	`{ amount: number; currency: string; data: PurchaseData; }`

`analytics/sinks/intelligems-sink`

@replohq/sdk/analytics/sinks/intelligems-sink

`IntelligemsEventMappings`

Each mapping receives the event’s typed payload.

import type { IntelligemsEventMappings } from "@replohq/sdk/analytics/sinks/intelligems-sink";

Field	Type	Required
`addToCart`	`(payload: CartLineEventPayload) => CustomEventPayload \| null`	No
`click`	`(payload: ClickPayload) => CustomEventPayload \| null`	No
`pageView`	`(metadata?: PageMetadata) => CustomEventPayload \| null`	No
`productViewed`	`(payload: ProductViewedPayload) => CustomEventPayload \| null`	No
`purchase`	`(payload: PurchasePayload) => CustomEventPayload \| null`	No
`removeFromCart`	`(payload: CartLineEventPayload) => CustomEventPayload \| null`	No
`startCheckout`	`(payload: CheckoutStartedPayload \| LegacyCheckoutStartedPayload) => CustomEventPayload \| null`	No
`viewCart`	`(payload: CartViewedPayload) => CustomEventPayload \| null`	No
`viewCollection`	`(payload: CollectionViewedPayload) => CustomEventPayload \| null`	No

`IntelligemsSink`

Sends explicitly selected custom goals through the installed Intelligems SDK. Native page views, experiment assignment, and order attribution remain owned by useIgTrack and Shopify; duplicating them as custom events changes reports.

import { IntelligemsSink } from "@replohq/sdk/analytics/sinks/intelligems-sink";

IntelligemsSink: typeof IntelligemsSink

`analytics/hooks/use-product-viewed-analytics`

@replohq/sdk/analytics/hooks/use-product-viewed-analytics

`useProductViewedAnalytics`

Fires a productViewed analytics event when the product or selected variant changes. Deduplicates by product+variant ID so the same combination is only tracked once per component lifecycle.

import { useProductViewedAnalytics } from "@replohq/sdk/analytics/hooks/use-product-viewed-analytics";

useProductViewedAnalytics: ({ product, selectedVariant, }: UseProductViewedAnalyticsProps) => void

`analytics/hooks/use-collection-viewed-analytics`

@replohq/sdk/analytics/hooks/use-collection-viewed-analytics

`useCollectionViewedAnalytics`

Fires a viewCollection analytics event carrying the collection’s products once the collection and its product list are both available. Re-renders and product-list updates for the same collection do not fire again; a different collection does, and returning to an earlier one counts as a new view, matching useProductViewedAnalytics.

import { useCollectionViewedAnalytics } from "@replohq/sdk/analytics/hooks/use-collection-viewed-analytics";

useCollectionViewedAnalytics: ({ collection, products, }: UseCollectionViewedAnalyticsProps) => void

Git

Replo SDK

Full SDK Reference

`analytics/analytics-provider`

`useAnalytics`

`useAnalyticsOptional`

`useAnalyticsSink`

`analytics/analytics-sink`

`AnalyticsProductLine`

`AnalyticsSink`

`CartLineData`

`CartViewedData`

`CheckoutStartedData`

`ClickData`

`CollectionViewedData`

`LegacyCheckoutLineItem`

`LegacyCheckoutStartedData`

`LegacyMoney`

`ProductViewedData`

`PurchaseData`

`analytics/sinks/intelligems-sink`

`IntelligemsEventMappings`

`IntelligemsSink`

`analytics/hooks/use-product-viewed-analytics`

`useProductViewedAnalytics`

`analytics/hooks/use-collection-viewed-analytics`

`useCollectionViewedAnalytics`

​analytics/analytics-provider

​useAnalytics

​useAnalyticsOptional

​useAnalyticsSink

​analytics/analytics-sink

​AnalyticsProductLine

​AnalyticsSink

​CartLineData

​CartViewedData

​CheckoutStartedData

​ClickData

​CollectionViewedData

​LegacyCheckoutLineItem

​LegacyCheckoutStartedData

​LegacyMoney

​ProductViewedData

​PurchaseData

​analytics/sinks/intelligems-sink

​IntelligemsEventMappings

​IntelligemsSink

​analytics/hooks/use-product-viewed-analytics

​useProductViewedAnalytics

​analytics/hooks/use-collection-viewed-analytics

​useCollectionViewedAnalytics

`analytics/analytics-provider`

`useAnalytics`

`useAnalyticsOptional`

`useAnalyticsSink`

`analytics/analytics-sink`

`AnalyticsProductLine`

`AnalyticsSink`

`CartLineData`

`CartViewedData`

`CheckoutStartedData`

`ClickData`

`CollectionViewedData`

`LegacyCheckoutLineItem`

`LegacyCheckoutStartedData`

`LegacyMoney`

`ProductViewedData`

`PurchaseData`

`analytics/sinks/intelligems-sink`

`IntelligemsEventMappings`

`IntelligemsSink`

`analytics/hooks/use-product-viewed-analytics`

`useProductViewedAnalytics`

`analytics/hooks/use-collection-viewed-analytics`

`useCollectionViewedAnalytics`