Home > @infiniteobjects/shopify-data-manager > AdminTypes > CustomerVisit
Represents a customer’s session visiting a shop’s online store, including information about the marketing activity attributed to starting the session.
Signature:
export interface CustomerVisit extends CustomerMoment, Node
Extends: CustomerMoment, Node
Property | Modifiers | Type | Description |
---|---|---|---|
id | Scalars[‘ID’][‘output’] | A globally-unique ID. | |
landingPage? | Maybe<Scalars[‘URL’][‘output’]> | (Optional) URL of the first page the customer landed on for the session. | |
landingPageHtml? | Maybe<Scalars[‘HTML’][‘output’]> | (Optional) Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1. | |
marketingEvent? | Maybe<MarketingEvent> | (Optional) Represent actions taken by an app, on behalf of a merchant, to market Shopify resources such as products, collections, and discounts. | |
occurredAt | Scalars[‘DateTime’][‘output’] | The date and time when the customer’s session occurred. | |
referralCode? | Maybe<Scalars[‘String’][‘output’]> | (Optional) Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. | |
referralInfoHtml | Scalars[‘FormattedString’][‘output’] | Referral information with URLs linked in HTML. | |
referrerUrl? | Maybe<Scalars[‘URL’][‘output’]> | (Optional) Webpage where the customer clicked a link that sent them to the online store. For example, _https://randomblog.com/page1_ or _android-app://com.google.android.gm_. | |
source | Scalars[‘String’][‘output’] | Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. | |
sourceDescription? | Maybe<Scalars[‘String’][‘output’]> | (Optional) Describes the source explicitly for first or last session. | |
sourceType? | Maybe<MarketingTactic | `${MarketingTactic}`> | (Optional) Type of marketing tactic. | |
utmParameters? | Maybe<UtmParameters> | (Optional) A set of UTM parameters gathered from the URL parameters of the referrer. |