CustomerVisit object

Information about a customer’s session on a shop’s online store.

Required access

read_orders access scope.

On this page

Fields

  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • landingPage ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    URL of the first page the customer landed on for the session.
  • landingPageHtml ([HTML](https://shopify.dev/docs/admin-api/graphql/reference/scalar#html-2021-01))
    Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.
  • marketingEvent ([MarketingEvent](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingevent))
    Represent actions taken by an app, on behalf of a merchant, to market Shopify resources such as products, collections, and discounts.
  • occurredAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    When the customer moment occurred.
  • referralCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    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!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#formattedstring-2021-01))
    Referral information with URLs linked in HTML.
  • referrerUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    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!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Describes the source explicitly for first or last session.
  • sourceType ([MarketingTactic](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingtactic))
    Type of marketing tactic.
  • utmParameters ([UTMParameters](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/utmparameters))
    A set of UTM parameters gathered from the URL parameters of the referrer.

Types that return CustomerVisit

  • [CustomerJourney.firstVisit](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customerjourney#firstvisit-2021-01)
  • [CustomerJourney.lastVisit](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customerjourney#lastvisit-2021-01)
  • [CustomerJourneySummary.firstVisit](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customerjourneysummary#firstvisit-2021-01)
  • [CustomerJourneySummary.lastVisit](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customerjourneysummary#lastvisit-2021-01)

Implements

  • [CustomerMoment](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customermoment)
  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)