Edge: Most-used fields#
The table below gives information about most-used fields that you can import from Edge. 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 |
|---|---|---|---|
aggregate-value |
aggregate-value |
The overall aggregated metric value, based on the selected aggregation criteria for e-commerce metrics. |
dimension |
availability.availability-compliant-count |
availability.availability-compliant-count |
The total count of products or items that are compliant with defined availability standards. |
metric |
availability.availability-compliant-percent |
availability.availability-compliant-percent |
The percentage of products or items that are compliant with defined availability standards. |
metric |
availability.availability-total-count |
availability.availability-total-count |
The total count of products or items evaluated for availability compliance. |
metric |
availability.available-for-sale-count |
availability.available-for-sale-count |
The count of products or items currently listed as available for sale. |
metric |
availability.available-for-sale-percent |
availability.available-for-sale-percent |
The percentage of products or items currently listed as available for sale. |
metric |
availability.items.{NUM}.count |
availability.items.{NUM}.count |
The count of items associated with a specific availability status. |
metric |
availability.items.{NUM}.label |
availability.items.{NUM}.label |
The descriptive label for a particular availability status (e.g., ‘In Stock’, ‘Out of Stock’). |
dimension |
availability.items.{NUM}.percent |
availability.items.{NUM}.percent |
The percentage of items associated with a specific availability status. |
metric |
availability.unavailable-for-sale-count |
availability.unavailable-for-sale-count |
The count of products or items currently listed as unavailable for sale. |
metric |
availability.unavailable-for-sale-percent |
availability.unavailable-for-sale-percent |
The percentage of products or items currently listed as unavailable for sale. |
metric |
content.content-compliant-count |
content.content-compliant-count |
The total count of products or items that comply with defined content quality standards. |
metric |
content.content-compliant-percent |
content.content-compliant-percent |
The percentage of products or items that comply with defined content quality standards. |
metric |
content.content-total-count |
content.content-total-count |
The total count of products or items evaluated for content compliance. |
metric |
imaging-compliance.image-compliance-compliant-percent |
imaging-compliance.image-compliance-compliant-percent |
The percentage of products or items that comply with primary image standards. |
metric |
imaging-compliance.image-compliance-secondary-compliant-percent |
imaging-compliance.image-compliance-secondary-compliant-percent |
The percentage of products or items that comply with secondary image standards. |
dimension |
imaging-compliance.items.{NUM}.compliant-count |
imaging-compliance.items.{NUM}.compliant-count |
The count of images that meet the defined compliance standards for a specific item and image type. This metric is crucial for assessing adherence to content guidelines or technical specifications. |
metric |
imaging-compliance.items.{NUM}.compliant-percent |
imaging-compliance.items.{NUM}.compliant-percent |
The percentage of images that meet the defined compliance standards for a specific item and image type. This provides a clear indicator of the overall compliance rate. |
metric |
imaging-compliance.items.{NUM}.image-type |
imaging-compliance.items.{NUM}.image-type |
The classification or category of the image being assessed for compliance. This could differentiate between various image uses, such as product main images, thumbnails, or lifestyle images. |
dimension |
imaging-compliance.items.{NUM}.total-count |
imaging-compliance.items.{NUM}.total-count |
The total number of images considered in the compliance assessment for a specific item and image type. |
metric |
imaging.imaging-compliant-count |
imaging.imaging-compliant-count |
The total count of products or items that comply with overall imaging standards. |
dimension |
imaging.imaging-compliant-percent |
imaging.imaging-compliant-percent |
The percentage of products or items that comply with overall imaging standards. |
dimension |
imaging.imaging-total-count |
imaging.imaging-total-count |
The total count of products or items evaluated for imaging compliance. |
dimension |
is-competitor |
is-competitor |
Indicates whether the data point relates to a competitor’s performance or your own. |
dimension |
media.media-compliant-count |
media.media-compliant-count |
The total count of products or items that comply with defined rich media standards (e.g., videos, 360-degree views). |
dimension |
media.media-compliant-percent |
media.media-compliant-percent |
The percentage of products or items that comply with defined rich media standards. |
dimension |
menu.menu-compliant-count |
menu.menu-compliant-count |
The total count of products or items that comply with menu or navigation related standards. |
metric |
menu.menu-compliant-percent |
menu.menu-compliant-percent |
The percentage of products or items that comply with menu or navigation related standards. |
metric |
menu.menu-total-count |
menu.menu-total-count |
The total count of products or items evaluated for menu or navigation compliance. |
metric |
overall.overall-compliant-percent |
overall.overall-compliant-percent |
The aggregate percentage of products or items that are compliant across all evaluated performance and content standards. |
metric |
pricing.above-max-price-count |
pricing.above-max-price-count |
The count of products or items priced above the predefined maximum price threshold. |
dimension |
pricing.above-max-price-percent |
pricing.above-max-price-percent |
The percentage of products or items priced above the predefined maximum price threshold. |
dimension |
pricing.above-msrp-count |
pricing.above-msrp-count |
The count of products or items priced above the Manufacturer’s Suggested Retail Price (MSRP). |
dimension |
pricing.above-msrp-percent |
pricing.above-msrp-percent |
The percentage of products or items priced above the Manufacturer’s Suggested Retail Price (MSRP). |
dimension |
pricing.average-diff-above-max |
pricing.average-diff-above-max |
The average absolute difference in price for products or items priced above the defined maximum. |
dimension |
pricing.average-diff-above-max-percent |
pricing.average-diff-above-max-percent |
The average percentage difference in price for products or items priced above the defined maximum. |
dimension |
pricing.average-diff-below-min |
pricing.average-diff-below-min |
The average absolute difference in price for products or items priced below the defined minimum. |
dimension |
pricing.average-diff-below-min-percent |
pricing.average-diff-below-min-percent |
The average percentage difference in price for products or items priced below the defined minimum. |
dimension |
pricing.average-diff-from-msrp |
pricing.average-diff-from-msrp |
The average absolute difference between the current price and the Manufacturer’s Suggested Retail Price (MSRP). |
dimension |
pricing.average-diff-from-msrp-percent |
pricing.average-diff-from-msrp-percent |
The average percentage difference between the current price and the Manufacturer’s Suggested Retail Price (MSRP). |
dimension |
pricing.average-price |
pricing.average-price |
The average selling price across a selection of products or items. |
metric |
pricing.average-price-decrease |
pricing.average-price-decrease |
The average decrease in price observed for products or items. |
dimension |
pricing.average-price-decrease-percent |
pricing.average-price-decrease-percent |
The average percentage decrease in price observed for products or items. |
dimension |
pricing.average-price-increase |
pricing.average-price-increase |
The average increase in price observed for products or items. |
dimension |
pricing.average-price-increase-percent |
pricing.average-price-increase-percent |
The average percentage increase in price observed for products or items. |
dimension |
pricing.below-min-price-count |
pricing.below-min-price-count |
The count of products or items priced below the predefined minimum price threshold. |
dimension |
pricing.below-min-price-percent |
pricing.below-min-price-percent |
The percentage of products or items priced below the predefined minimum price threshold. |
dimension |
pricing.below-msrp-count |
pricing.below-msrp-count |
The count of products or items priced below the Manufacturer’s Suggested Retail Price (MSRP). |
dimension |
pricing.below-msrp-percent |
pricing.below-msrp-percent |
The percentage of products or items priced below the Manufacturer’s Suggested Retail Price (MSRP). |
dimension |
pricing.currency-symbol |
pricing.currency-symbol |
The currency symbol used for pricing information (e.g., ‘$’, ‘€’). |
dimension |
pricing.min-max-price-compliant-count |
pricing.min-max-price-compliant-count |
The count of products or items that adhere to specified minimum and maximum price boundaries. |
dimension |
pricing.min-max-price-compliant-percent |
pricing.min-max-price-compliant-percent |
The percentage of products or items that adhere to specified minimum and maximum price boundaries. |
dimension |
pricing.msrp-compliant-count |
pricing.msrp-compliant-count |
The count of products or items that comply with Manufacturer’s Suggested Retail Price (MSRP) guidelines. |
dimension |
pricing.msrp-compliant-percent |
pricing.msrp-compliant-percent |
The percentage of products or items that comply with Manufacturer’s Suggested Retail Price (MSRP) guidelines. |
dimension |
pricing.price-decrease-count |
pricing.price-decrease-count |
The count of products or items that have experienced a price decrease. |
metric |
pricing.price-decrease-percent |
pricing.price-decrease-percent |
The percentage of products or items that have experienced a price decrease. |
metric |
pricing.price-increase-count |
pricing.price-increase-count |
The count of products or items that have experienced a price increase. |
metric |
pricing.price-increase-percent |
pricing.price-increase-percent |
The percentage of products or items that have experienced a price increase. |
metric |
pricing.pricing-compliant-count |
pricing.pricing-compliant-count |
The total count of products or items that comply with overall pricing standards. |
dimension |
pricing.pricing-compliant-percent |
pricing.pricing-compliant-percent |
The percentage of products or items that comply with overall pricing standards. |
dimension |
pricing.pricing-total-count |
pricing.pricing-total-count |
The total count of products or items evaluated for pricing compliance. |
dimension |
promotion.average-discount |
promotion.average-discount |
The average monetary discount applied to products or items that are currently on promotion. |
dimension |
promotion.average-discount-percent |
promotion.average-discount-percent |
The average percentage discount applied to products or items that are currently on promotion. |
dimension |
promotion.on-promotion-below-min-price-count |
promotion.on-promotion-below-min-price-count |
The count of products or items that are currently on promotion and priced below the minimum price threshold. |
dimension |
promotion.on-promotion-below-min-price-percent |
promotion.on-promotion-below-min-price-percent |
The percentage of products or items that are currently on promotion and priced below the minimum price threshold. |
dimension |
promotion.on-promotion-count |
promotion.on-promotion-count |
The count of products or items that are currently being offered on promotion. |
metric |
promotion.on-promotion-percent |
promotion.on-promotion-percent |
The percentage of products or items that are currently being offered on promotion. |
metric |
ratings-and-reviews.1-star-count |
ratings-and-reviews.1-star-count |
The count of products or items that have received a 1-star rating. |
metric |
ratings-and-reviews.1-star-percent |
ratings-and-reviews.1-star-percent |
The percentage of products or items that have received a 1-star rating. |
dimension |
ratings-and-reviews.2-star-count |
ratings-and-reviews.2-star-count |
The count of products or items that have received a 2-star rating. |
metric |
ratings-and-reviews.2-star-percent |
ratings-and-reviews.2-star-percent |
The percentage of products or items that have received a 2-star rating. |
dimension |
ratings-and-reviews.3-star-count |
ratings-and-reviews.3-star-count |
The count of products or items that have received a 3-star rating. |
metric |
ratings-and-reviews.3-star-percent |
ratings-and-reviews.3-star-percent |
The percentage of products or items that have received a 3-star rating. |
dimension |
ratings-and-reviews.4-star-count |
ratings-and-reviews.4-star-count |
The count of products or items that have received a 4-star rating. |
metric |
ratings-and-reviews.4-star-percent |
ratings-and-reviews.4-star-percent |
The percentage of products or items that have received a 4-star rating. |
dimension |
ratings-and-reviews.5-star-count |
ratings-and-reviews.5-star-count |
The count of products or items that have received a 5-star rating. |
metric |
ratings-and-reviews.5-star-percent |
ratings-and-reviews.5-star-percent |
The percentage of products or items that have received a 5-star rating. |
dimension |
ratings-and-reviews.average-rating |
ratings-and-reviews.average-rating |
The average star rating across all reviewed products or items. |
dimension |
ratings-and-reviews.average-review-count |
ratings-and-reviews.average-review-count |
The average number of reviews received per product or item. |
dimension |
ratings-and-reviews.not-rated-count |
ratings-and-reviews.not-rated-count |
The count of products or items that have not yet received any ratings. |
metric |
ratings-and-reviews.not-rated-percent |
ratings-and-reviews.not-rated-percent |
The percentage of products or items that have not yet received any ratings. |
dimension |
ratings-and-reviews.rating-compliant-count |
ratings-and-reviews.rating-compliant-count |
The count of products or items that are compliant with defined rating standards (e.g., minimum number of ratings). |
metric |
ratings-and-reviews.rating-compliant-percent |
ratings-and-reviews.rating-compliant-percent |
The percentage of products or items that are compliant with defined rating standards. |
dimension |
ratings-and-reviews.rating-total-count |
ratings-and-reviews.rating-total-count |
The total count of products or items evaluated for rating compliance. |
metric |
ratings-and-reviews.review-compliant-count |
ratings-and-reviews.review-compliant-count |
The count of products or items that are compliant with defined review standards (e.g., minimum number of reviews, content quality). |
metric |
ratings-and-reviews.review-compliant-percent |
ratings-and-reviews.review-compliant-percent |
The percentage of products or items that are compliant with defined review standards. |
dimension |
ratings-and-reviews.review-total-count |
ratings-and-reviews.review-total-count |
The total count of products or items evaluated for review compliance. |
metric |
report-date |
report-date |
The date when the reported data was generated or collected. |
dimension |
search-scores.search-score-compliant-percent |
search-scores.search-score-compliant-percent |
The percentage of products or items that are compliant with defined search score standards, indicating optimal search visibility. |
metric |
share-of-search.organic-share-of-search-compliant-percent |
share-of-search.organic-share-of-search-compliant-percent |
The percentage of products or items that are compliant with organic share-of-search metrics, reflecting unpaid search visibility. |
metric |
share-of-search.paid-share-of-search-compliant-percent |
share-of-search.paid-share-of-search-compliant-percent |
The percentage of products or items that are compliant with paid share-of-search metrics, reflecting paid search visibility. |
metric |
share-of-search.search-term-groups.items.{NUM}.compliant-percent |
share-of-search.search-term-groups.items.{NUM}.compliant-percent |
The percentage of products within a specific search term group that meet overall share-of-search compliance criteria. |
metric |
share-of-search.search-term-groups.items.{NUM}.name |
share-of-search.search-term-groups.items.{NUM}.name |
The name of the search term group. |
dimension |
share-of-search.search-term-groups.items.{NUM}.organic-compliant-percent |
share-of-search.search-term-groups.items.{NUM}.organic-compliant-percent |
The percentage of products within a specific search term group that meet organic share-of-search compliance criteria. |
metric |
share-of-search.search-term-groups.items.{NUM}.paid-compliant-percent |
share-of-search.search-term-groups.items.{NUM}.paid-compliant-percent |
The percentage of products within a specific search term group that meet paid share-of-search compliance criteria. |
metric |
share-of-search.share-of-search-compliant-percent |
share-of-search.share-of-search-compliant-percent |
The overall percentage of products or items that are compliant with total share-of-search metrics, encompassing both organic and paid visibility. |
metric |