CustomerVisit

Required access

read_orders access scope

Show definition
type CustomerVisit implements CustomerMoment, Node {
  # When the customer moment occurred.
  occurredAt: DateTime!

  # Globally unique identifier.
  id: ID!

  # URL of the first page the customer landed on for the session.
  landingPage: URL

  # Landing page information with URL linked in HTML. For example, the first page
  # the customer visited was store.myshopify.com/products/1.
  landingPageHtml: HTML

  # Represent actions taken by an app, on behalf of a merchant,
  # to market Shopify resources such as products, collections, and discounts.
  marketingEvent: MarketingEvent

  # 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.
  referralCode: String

  # Describes the source type and platform of the visit,         such as a visit to a store's home page from a Facebook ad.
  referralInfo: String!

  # Referral information with URLs linked in HTML.
  referralInfoHtml: FormattedString!

  # 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_.
  referrerUrl: URL

  # Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct,
  # a website domain, QR code, or unknown.
  source: String!

  # Describes the source explicitly for first or last visit.
  sourceDescription: String

  # Type of marketing tactic.
  sourceType: MarketingTactic

  # A set of UTM parameters gathered from the URL parameters of the referrer.
  utmParameters: UTMParameters
}

Implements

Fields

id   (ID!)

Globally unique identifier.

landingPage   (URL)

URL of the first page the customer landed on for the session.

landingPageHtml   (HTML)

Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.

marketingEvent   (MarketingEvent)

Represent actions taken by an app, on behalf of a merchant, to market Shopify resources such as products, collections, and discounts.

occurredAt   (DateTime!)

When the customer moment occurred.

referralCode   (String)

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   (FormattedString!)

Referral information with URLs linked in HTML.

referrerUrl   (URL)

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   (String!)

Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.

sourceDescription   (String)

Describes the source explicitly for first or last visit.

sourceType   (MarketingTactic)

Type of marketing tactic.

utmParameters   (UTMParameters)

A set of UTM parameters gathered from the URL parameters of the referrer.

Deprecated fields

Show/Hide

referralInfo   (String!) deprecated

Describes the source type and platform of the visit, such as a visit to a store's home page from a Facebook ad.

Deprecation warning

Use referralInfoHtml instead