Shopalyst: Most-used fields
The table below gives information about most-used fields that you can import from Shopalyst. 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.
availabilityDimension
The on-shelf availability status of a product, indicating whether it is in stock or available for purchase.
brandDimension
The name or identifier of a product's brand.
brandCategoryDimension
The category associated with a brand, used for categorization and filtering in analytics and reporting.
brandDivisionDimension
The division to which a brand belongs, used for organizational structure and segmentation in analytics.
categoriesDimension
A list of categories to which a product belongs.
competitorsDimension
A list of competitor brands or products used for comparative analysis in various reports like 'Best Sellers Trending Products' or 'Pricing'.
countryDimension
The country code (e.g., 'us' for USA, 'in' for India) relevant to the product data or market analysis.
createdDateDimension
The initial date an item, product, or record was first published or created on the requested channel or platform.
dateDimension
The specific date or time period for which the collected data or insights are relevant. This field is commonly used as a filter for retrieving historical data from various insight endpoints like pricing, ratings, or share of search.
discountPctMetric
The percentage of discount applied to a product.
divisionDimension
The product division to which an item belongs (e.g., 'beauty', 'electronics').
errorCodeDimension
A numerical code indicating the specific type of error that occurred during an API request or data processing.
keywordDimension
A term or phrase used in search queries, often associated with insights related to 'Share of Search' or audience targeting within marketing campaigns.
keywordsDimension
A collection of words or phrases associated with a product or search context, crucial for product discovery and audience targeting.
merchantDimension
The name or identifier of the merchant selling the product, such as 'amazon' or 'walmart'.
merchantDivisionsDimension
A collection of product divisions or categories within a merchant's catalog, often used for best-seller reporting.
messageDimension
A descriptive textual message providing additional information about the status of an API request, a process, or an error.
nameDimension
The human-readable name of an entity, such as a brand name, merchant division name, product name, or category name.
offerPriceMetric
The current discounted price or special offer price of the product.
pageDimension
Refers to a specific page number in paginated results or a type of page where an ad or product is displayed.
productImageDimension
The URL of the primary image associated with a product.
resultDimension
A container key in the API response that holds the primary data payload or a list of data records for a given request.
salePriceMetric
The Maximum Retail Price (MRP) or original selling price of the product before any discounts.
scoreMetric
A numerical value representing a performance metric or an evaluated rating, such as a product rating, a share metric (e.g., Share of Search, Share of Voice), or another quantitative indicator.
searchKeywordsDimension
Keywords that consumers actively use to search for products, directly impacting product visibility and discovery.
shareMetric
The proportion or percentage representing market presence or visibility, such as a product's 'Share of Search' or 'Share of Voice'.
skuIdDimension
The Stock Keeping Unit identifier, a unique code used to identify a specific product or item, commonly found in product-related reports like 'Trending Products' or 'Pricing'.
successDimension
A boolean indicator (true/false) denoting whether an operation, API request, or data processing task was completed successfully.
titleDimension
The main title or name of the product as displayed on the merchant's website.
updatedDateDimension
The last date and time when the information or attributes of an item, product, or record were changed or modified.