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.

API name	Adverity UI name	Description	Use in Adverity
active	active	Indicates the stock status of a product (e.g., true for in stock, false for out of stock).	dimension
availability	availability	The on-shelf availability status of a product, indicating whether it is in stock or available for purchase.	dimension
avgRating	avgRating	The average rating of a product, aggregated from customer reviews.	metric
brand	brand	The name or identifier of a product’s brand.	dimension
brandCategory	brandCategory	The category associated with a brand, used for categorization and filtering in analytics and reporting.	dimension
brandDivision	brandDivision	The division to which a brand belongs, used for organizational structure and segmentation in analytics.	dimension
categories	categories	A list of categories to which a product belongs.	dimension
categoryRank	categoryRank	The ranking of a product within its specific category.	metric
changed	changed	A flag indicating if the product’s data has undergone a change.	dimension
code	code		metric
competitors	competitors	A list of competitor brands or products used for comparative analysis in various reports like ‘Best Sellers Trending Products’ or ‘Pricing’.	dimension
country	country	The country code (e.g., ‘us’ for USA, ‘in’ for India) relevant to the product data or market analysis.	dimension
createdDate	createdDate	The timestamp indicating when a particular record, entity, or data entry was first created in the system.	dimension
date	date	The specific date for which the data or insights are reported, typically used for daily data requests across various reports.	dimension
discount	discount	The percentage value representing the price reduction applied to a product.	metric
discountPct	discountPct	The percentage of discount applied to a product.	metric
division	division	The product division to which an item belongs (e.g., ‘beauty’, ‘electronics’).	dimension
errorCode	errorCode	A numerical code indicating the specific type of error that occurred during an API request or data processing.	dimension
extAttributes	extAttributes	A collection of extended or custom attributes associated with a product.	dimension
imageUrl	imageUrl	The URL for the primary image of the product.	dimension
keyword	keyword	A term or phrase used in search queries, often associated with insights related to ‘Share of Search’ or audience targeting within marketing campaigns.	dimension
keywords	keywords	A collection of words or phrases associated with a product or search context, crucial for product discovery and audience targeting.	dimension
lastChangedTime	lastChangedTime	The timestamp indicating the last time a product’s data was modified.	metric
merchant	merchant	The name or identifier of the merchant selling the product, such as ‘amazon’ or ‘walmart’.	dimension
merchantDivisions	merchantDivisions	A collection of product divisions or categories within a merchant’s catalog, often used for best-seller reporting.	dimension
message	message	A descriptive textual message providing additional information about the status of an API request, a process, or an error.	dimension
name	name	The human-readable name of an entity, such as a brand name, merchant division name, product name, or category name.	dimension
newArrival	newArrival	A flag indicating if the product is considered a new arrival.	dimension
offerPrice	offerPrice	The current discounted price or special offer price of the product.	metric
page	page	Refers to a specific page number in paginated results or a type of page where an ad or product is displayed.	dimension
productId	productId	The unique identifier assigned to the product by Shopalyst.	dimension
productImage	productImage	The URL of the primary image associated with a product.	dimension
productUrl	productUrl	The direct URL to the product page on the merchant’s website.	dimension
ratingsCount	ratingsCount	The total number of ratings a product has received.	metric
ratingsDistribution	ratingsDistribution	The breakdown of ratings received by a product across different star levels (e.g., 1-star, 5-star counts).	dimension
result	result	A container key in the API response that holds the primary data payload or a list of data records for a given request.	dimension
reviewsCount	reviewsCount	The total number of customer reviews submitted for a product.	metric
salePrice	salePrice	The Maximum Retail Price (MRP) or original selling price of the product before any discounts.	metric
score	score	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.	metric
searchKeywords	searchKeywords	Keywords that consumers actively use to search for products, directly impacting product visibility and discovery.	dimension
seoTitle	seoTitle	The SEO-friendly title of the product, optimized for search engine visibility.	dimension
share	share	The proportion or percentage representing market presence or visibility, such as a product’s ‘Share of Search’ or ‘Share of Voice’.	metric
skuId	skuId	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’.	dimension
success	success	A boolean indicator (true/false) denoting whether an operation, API request, or data processing task was completed successfully.	dimension
title	title	The main title or name of the product as displayed on the merchant’s website.	dimension
trendingRank	trendingRank	The ranking of a product based on its trending performance or popularity.	metric
trueDiscount	trueDiscount	The actual or effective discount value applied to a product.	metric
updatedDate	updatedDate	The timestamp indicating the last time a particular record, entity, or data entry was modified or updated in the system.	dimension