Shopify (GraphQL): Most-used fields#
The table below gives information about most-used fields that you can import from Shopify (GraphQL). Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
Billing address post code |
Billing address post code |
The postal code or zip code of the billing address associated with the order. This maps to the zip field within the BillingAddress object. |
dimension |
Channel ID |
Channel ID |
The unique identifier for the sales channel through which the order was placed or a product was published. This maps to Channel.id in the API. |
dimension |
Channel name |
Channel name |
The human-readable name of the sales channel (e.g., ‘Online Store’, ‘Point of Sale’). This maps to Channel.name in the API. |
dimension |
Created at |
Created at |
The timestamp indicating when a record or resource was created. |
dimension |
Customer ID |
Customer ID |
The unique identifier for the customer. This maps to Customer.id in the API. |
dimension |
Customer email |
Customer email |
The primary email address of the customer. This maps to Customer.email in the API. |
dimension |
Customer journey attribution ready |
Customer journey attribution ready |
Indicates whether data relevant to customer journey tracking and marketing attribution, such as session data, attribution sources (e.g., UTM parameters, referrers), and the timeline from initial visit to purchase, has been collected and is available for analysis. This leverages Shopify’s CustomerJourney and CustomerJourneySummary objects. |
dimension |
Customer journey first session ID |
Customer journey first session ID |
The unique identifier for the customer’s first recorded session leading to the order within the attribution window. |
dimension |
Customer journey first session UTM campaign |
Customer journey first session UTM campaign |
The UTM campaign parameter from the customer’s first session, indicating the specific marketing campaign that drove the visit. This is part of the utmParameters.campaign field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey first session UTM content |
Customer journey first session UTM content |
The UTM content parameter from the customer’s first session, used to differentiate between similar content or links within a marketing campaign. This is part of the utmParameters.content field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey first session UTM medium |
Customer journey first session UTM medium |
The UTM medium parameter from the customer’s first session, indicating the marketing medium (e.g., email, CPC). This is part of the utmParameters.medium field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey first session UTM source |
Customer journey first session UTM source |
The UTM source parameter from the customer’s first session, indicating where the traffic originated (e.g., Google, Facebook). This is part of the utmParameters.source field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey first session UTM term |
Customer journey first session UTM term |
The UTM term parameter captured during the customer’s first session, indicating keywords or specific terms associated with the marketing campaign. |
dimension |
Customer journey first session landing page |
Customer journey first session landing page |
The URL of the first page the customer landed on during their initial session. This is represented by the landingPage property within CustomerJourneySummary or CustomerVisit objects in the GraphQL Admin API. |
dimension |
Customer journey first session occured at |
Customer journey first session occured at |
The date and time when the customer’s first session occurred, leading to the order within the attribution window. |
dimension |
Customer journey first session referral code |
Customer journey first session referral code |
The marketing referral code from the link that the customer clicked to visit the store during their first session. |
dimension |
Customer journey first session referrer URL |
Customer journey first session referrer URL |
The URL of the page that referred the customer to the store for their first session. This is part of the referrerUrl field within CustomerJourneySummary or CustomerVisit objects. |
dimension |
Customer journey first session source |
Customer journey first session source |
The high-level source of traffic for the customer’s first session (e.g., direct, organic, referral). This is part of the source field within CustomerJourneySummary or CustomerVisit objects. |
dimension |
Customer journey first session source description |
Customer journey first session source description |
A detailed description of the source from which the customer visited the store during their first session, providing more context than the source type. |
dimension |
Customer journey first session source type |
Customer journey first session source type |
The type of source from which the customer visited the store during their first session, such as a platform (e.g., Facebook, Google), email, direct, or unknown. |
dimension |
Customer journey last session ID |
Customer journey last session ID |
The unique identifier for the customer’s last recorded session immediately preceding the order within the attribution window. |
dimension |
Customer journey last session UTM campaign |
Customer journey last session UTM campaign |
The UTM campaign parameter from the customer’s last session, indicating the specific marketing campaign that drove the most recent visit. This is part of the utmParameters.campaign field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey last session UTM content |
Customer journey last session UTM content |
The UTM content parameter from the customer’s last session, used to differentiate between similar content or links within a campaign. This is part of the utmParameters.content field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey last session UTM medium |
Customer journey last session UTM medium |
The UTM medium parameter from the customer’s last session, indicating the marketing medium (e.g., email, CPC). This is part of the utmParameters.medium field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey last session UTM source |
Customer journey last session UTM source |
The UTM source parameter from the customer’s last session, indicating where the traffic originated (e.g., Google, Facebook). This is part of the utmParameters.source field within CustomerVisit or CustomerJourneySummary objects. |
dimension |
Customer journey last session UTM term |
Customer journey last session UTM term |
The UTM term parameter captured during the customer’s last session, indicating keywords or specific terms associated with the marketing campaign. |
dimension |
Customer journey last session landing page |
Customer journey last session landing page |
The URL of the last page the customer landed on during their most recent session. This is represented by the landingPage property within CustomerJourneySummary or CustomerVisit objects in the GraphQL Admin API. |
dimension |
Customer journey last session occured at |
Customer journey last session occured at |
The date and time when the customer’s last session occurred, immediately preceding the order within the attribution window. |
dimension |
Customer journey last session referral code |
Customer journey last session referral code |
The marketing referral code from the link that the customer clicked to visit the store during their last session. |
dimension |
Customer journey last session referrer URL |
Customer journey last session referrer URL |
The URL of the page that referred the customer to the store for their last session. This is part of the referrerUrl field within CustomerJourneySummary or CustomerVisit objects. |
dimension |
Customer journey last session source |
Customer journey last session source |
The high-level source of traffic for the customer’s last session (e.g., direct, organic, referral). This is part of the source field within CustomerJourneySummary or CustomerVisit objects. |
dimension |
Customer journey last session source description |
Customer journey last session source description |
A detailed description of the source from which the customer visited the store during their last session, providing more context than the source type. |
dimension |
Customer journey last session source type |
Customer journey last session source type |
The type of source from which the customer visited the store during their last session, such as a platform (e.g., Facebook, Google), email, direct, or unknown. |
dimension |
Customer journey order index |
Customer journey order index |
The sequential position of the current order within the customer’s complete purchase history. |
metric |
Day |
Day |
A temporal dimension representing a specific day, used for reporting and aggregating sales or other data on a daily basis. |
dimension |
Line items quantities |
Line items quantities |
The total quantity of all individual items (line items) within an order. This is a sum of the LineItem.quantity for all line items associated with an order. |
metric |
Order ID |
Order ID |
A unique internal identifier assigned by Shopify to each order. |
dimension |
Order id |
Order id |
A unique internal identifier assigned by Shopify to each order. |
metric |
Order name |
Order name |
A customer-facing and customizable name or number for an order, often visible in the Shopify admin. |
dimension |
Order net payment amount |
Order net payment amount |
The total amount of money received for an order after all applicable discounts, returns, and allowances have been applied. |
metric |
Processed at |
Processed at |
The date and time when an order was processed. |
dimension |
Publication name |
Publication name |
The name of the publication or sales channel where a product or collection is published. This relates to the Channel.name field. |
dimension |
Shipping address country |
Shipping address country |
The country specified in the shipping address for the order. This maps to the country field within the ShippingAddress object. |
dimension |
Tags |
Tags |
A list of searchable, custom tags associated with an order or customer. This is a standard field on Order and Customer objects. |
dimension |
Total discounts amount |
Total discounts amount |
The total monetary amount of all discounts applied to an order. This is represented by totalDiscountsSet.shopMoney.amount on the Order object. |
metric |
Total order amount |
Total order amount |
The grand total value of an order, including products, shipping, and taxes, before any refunds. |
metric |
Total shipping amount |
Total shipping amount |
The total monetary amount charged for shipping on an order. This is represented by totalShippingPriceSet.shopMoney.amount on the Order object. |
metric |
Total tax amount |
Total tax amount |
The total monetary amount of all taxes applied to an order. This is represented by totalTaxSet.shopMoney.amount on the Order object. |
metric |
Updated at |
Updated at |
The timestamp indicating when a record or resource was last modified. |
dimension |
createdAt |
createdAt |
The date and time when the record (e.g., order, customer) was created. This is a standard API field available on many Shopify GraphQL objects. |
dimension |
createdAt.date |
createdAt.date |
The date and time when the record (e.g., Order, Product, Discount code) was created. |
dimension |
customer_id |
customer_id |
The unique identifier for the customer. This is an alias for ‘Customer ID’ and maps to Customer.id in the API. |
dimension |
customer_type |
customer_type |
A classification or categorization of a customer, derived from various customer attributes such as purchase history, total amount spent, contact details, and marketing preferences. The platform collects detailed customer information, enabling users to segment and define customer types based on their specific business needs. |
dimension |
date |
date |
A timestamp indicating a specific point in time related to an order or resource, such as when an order was created (createdAt) or last updated (updatedAt). |
dimension |
numberOfOrders |
numberOfOrders |
The total count of orders placed by a customer. This can be retrieved by querying the Customer.orders.totalCount or similar aggregation of orders associated with a customer. |
metric |
order_date |
order_date |
The date when the order was placed by the customer. This is often represented by a date component of createdAt on the Order object and can be used as a filter for order queries. |
dimension |
orders |
orders |
Represents a collection of customer orders. This refers to the Order object in the Shopify GraphQL Admin API. |
metric |
ownerId |
ownerId |
The globally unique identifier (GID) of the resource that owns a specific record, such as the customer, product, product variant, collection, or order to which a metafield is attached. |
dimension |
revenue |
revenue |
Represents the total sales revenue generated by the Shopify store. This value is derived from the sales dataset, which reflects sale agreements with customers, including pending and unpaid orders, rather than strictly completed revenue. It reports when there’s a reasonable belief that the value will be exchanged, but does not wait for actual payment or fulfillment. |
metric |
updatedAt |
updatedAt |
The date and time when the record (e.g., order, customer) was last updated. This is a standard API field available on many Shopify GraphQL objects. |
dimension |
updatedAt.date |
updatedAt.date |
The date and time when the record (e.g., Order, Metafield, Discount code, Return, Collection) was last updated or modified. |
dimension |