Skip to main content
object

Requires read_orders access scope or read_marketplace_orders access scope.

Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session.

ID!non-null

A globally-unique ID.

URL

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

HTML

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

MarketingEvent

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

DateTime!non-null

The date and time when the customer's session occurred.

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.

FormattedString!non-null

Referral information with URLs linked in HTML.

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.

String!non-null

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

String

Describes the source explicitly for first or last session.

MarketingTactic

Type of marketing tactic.

UTMParameters

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


Was this section helpful?


Was this section helpful?