CustomerVisit - admin-graphql - OBJECT
Version: 2024-10
Description:
Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session.
Access Scopes
`read_orders` access scope or `read_marketplace_orders` access scope.
Fields
-
id:
ID! -
A globally-unique ID.
-
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! -
The date and time when the customer's session 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 session.
-
sourceType:
MarketingTactic -
Type of marketing tactic.
-
utmParameters:
UTMParameters -
A set of UTM parameters gathered from the URL parameters of the referrer.
Connections
Related queries
Related mutations
Related Unions
Examples