Amazon Ads Reference

profileId

long

Profile ID

adGroupId

long

ID of the ad group

name

string

Name of the ad group

campaignId

long

ID of the campaign to which this ad group belongs

defaultBid

bigdecimal

The bid used when keywords belonging to this ad group don't specify a bid

state

string

Advertiser-specified state of the ad group

creationDate

timestamp

The date the ad group was created

lastUpdatedDate

timestamp

The date the ad group was last updated

servingStatus

string

The computed status, accounting for out of budget, policy violations, etc

profileId

long

Profile ID

advertiserId

long

The identifier of the advertiser

advertiserName

string

The name of the advertiser

profileId

long

Profile ID

id

string

The identifier of the publisher

macroEnabled

boolean

Set to 'true' if the publisher supports macros

name

string

The name of the publisher

profile_id

long

Profile ID

report_type

string

The type of report. Either PERFORMANCE or PRODUCTS

advertiser_id

long

One or more advertiser Ids to filter reporting by. If requesting reporting for multiple advertiser Ids, input via a comma-delimited list

date

date

Date on which the events took place. Applies to PERFORMANCE and PRODUCTS reportType

adGroupId

string

An ad group external identifier. Applies to PERFORMANCE and PRODUCTS reportType

advertiserName

string

Name of advertiser. Applies to PERFORMANCE and PRODUCTS reportType

brandName

string

Name of the advertiser's brand. Applies only to PRODUCTS reportType

campaignId

string

A campaign external identifier. Applies to PERFORMANCE and PRODUCTS reportType

creativeId

string

A creative external identifier. Applies only to PERFORMANCE reportType

marketplace

string

The Amazon-owned site the product is sold on. Applies only to PRODUCTS reportType

productAsin

string

A unique block of letters and/or numbers that identify all products sold on Amazon. Applies only to PRODUCTS reportType

productCategory

string

A classification for the type of product being sold which determines its place in the Amazon retail catalog. Contains categories of products. Applies only to PRODUCTS reportType

productSubcategory

string

A classification for the type of product being sold which determines its place in the Amazon retail catalog. Contains subcategories of products. Applies only to PRODUCTS reportType

productConversionType

string

The conversion type describes whether the conversion happened on a promoted or a brand halo ASIN. Applies only to PRODUCTS reportType

productGroup

string

A distinct product grouping distinguishing products like watches from video games from toys. Contains groups of products. Applies only to PRODUCTS reportType

productName

string

The name of the product. Applies only to PRODUCTS reportType

publisher

string

The publisher name. Applies to PERFORMANCE and PRODUCTS reportType

attributedAddToCartClicks14d

bigdecimal

The number of promoted add to cart conversions attributed to ad click-throughs within 14 days

attributedDetailPageViewsClicks14d

bigdecimal

The number of promoted detail page view conversions attributed to ad click-throughs within 14 days

attributedNewToBrandPurchases14d

bigdecimal

The number of promoted purchases made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days

attributedNewToBrandSales14d

bigdecimal

The aggregate value of promoted sales made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days

attributedNewToBrandUnitsSold14d

bigdecimal

The number of promoted units sold made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days

attributedPurchases14d

bigdecimal

The number of promoted purchases attributed to ad click-throughs within 14 days

attributedSales14d

bigdecimal

Aggregate value of promoted attributed sales occurring within 14 days of an attribution event in local currency

attributedTotalAddToCartClicks14d

bigdecimal

The number of total add to cart conversions attributed to ad click-throughs within 14 days, including brand halo

attributedTotalDetailPageViewsClicks14d

bigdecimal

The number of total detail page view conversions attributed to ad click-throughs within 14 days, including brand halo

attributedTotalPurchases14d

bigdecimal

The number of total purchases attributed to ad click-throughs within 14 days, including brand halo

brandHaloAttributedAddToCartClicks14d

bigdecimal

The number of Brand halo add to cart conversions attributed to ad click-throughs within 14 days

brandHaloAttributedPurchases14d

bigdecimal

The number of Brand halo purchases attributed to ad click-throughs within 14 days

brandHaloAttributedSales14d

bigdecimal

Aggregate value of Brand halo attributed sales occurring within 14 days of an attribution event in local currency

brandHaloDetailPageViewsClicks14d

bigdecimal

The number of Brand halo detail page view conversions attributed to ad click-throughs within 14 days

brandHaloNewToBrandPurchases14d

bigdecimal

The number of Brand halo purchases made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days

brandHaloNewToBrandSales14d

bigdecimal

The aggregate value of Brand halo sales made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days

brandHaloNewToBrandUnitsSold14d

bigdecimal

The number of Brand halo units sold made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days

brandHaloUnitsSold14d

bigdecimal

The number of Brand halo units sold attributed to ad click-throughs within 14 days

totalAttributedSales14d

bigdecimal

Aggregate value of total attributed sales occurring within 14 days of an attribution event in local currency, including brand halo

totalUnitsSold14d

bigdecimal

The number of total units sold attributed to ad click-throughs within 14 days, including brand halo

unitsSold14d

bigdecimal

The number of promoted units sold attributed to ad click-throughs within 14 days

profileId

long

Profile ID

advertiserId

string

The advertiser identifier

publisherId

string

Publisher Id

macroTag

string

profile_id

long

Profile ID

brandName

string

Brand Name

categoryNodeName

string

The hierarchical path that leads to a node starting with the root node. If no Category Node Name is passed, then all data available for all brands belonging to the entity are retrieved

categoryNodeTreeName

string

The node at the top of a browse tree. It is the start node of a tree

lookbackPeriod

string

Defines the period of time used to determine the number of shoppers in the metrics computation

metricsComputationDate

date

Metrics computation date

addToCarts

bigdecimal

shoppers that added [Brand Name] to cart in [categoryNodePath] in [lookBackPeriod]

addToCartsCategoryMedian

bigdecimal

shoppers that added the peer median to cart in [categoryNodePath] in [lookBackPeriod]

addToCartsReturnOnEngagement

bigdecimal

The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

addToCartsROECategoryMedian

bigdecimal

The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

addToCartsROECategoryTopPerformers

bigdecimal

The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category

awarenessIndex

bigdecimal

Awareness Index measures actual on-Amazon audience signals reflecting awareness for your brand in the short and long term, across the whole on-Amazon audience. The percentile lets you know how the awareness activity for your brand compares to that of your peers

brandCustomers

bigdecimal

0%-90% of sales contributing shoppers for [Brand Name] whom purchased in [categoryNodePath] in [lookBackPeriod]

brandCustomersCategoryMedian

bigdecimal

0%-90% of sales contributors for the peer median whom purchased in [categoryNodePath] in [lookBackPeriod]

brandCustomersCategoryTopPerformers

bigdecimal

0%-90% of sales contributors for avg. of the top 95th - 99th percent of peers whom purchased in [categoryNodePath] in [lookBackPeriod]

brandCustomersReturnOnEngagement

bigdecimal

The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category

brandCustomersROECategoryMedian

bigdecimal

The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category

brandCustomersROECategoryTopPerformers

bigdecimal

The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category

brandedSearchesAndDetailPageViews

bigdecimal

shoppers that searched brand and viewed detail page of [Brand Name] in [categoryNodePath] in [lookBackPeriod]

brandedSearchesAndDetailPageViewsCategoryMedian

bigdecimal

shoppers that searched brand and viewed the detail page of peer median in [categoryNodePath] in [lookBackPeriod]

brandedSearchesAndDetailPageViewsCategoryTopPerformers

bigdecimal

shoppers that searched brand and viewed the detail page of avg. of the top 95th - 99th percent of peers in [categoryNodePath] in [lookBackPeriod]

brandedSearchesAndDetailPageViewsReturnOnEngagement

bigdecimal

The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

brandedSearchesAndDetailPageViewsROECategoryMedian

bigdecimal

The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

brandedSearchesAndDetailPageViewsROECategoryTopPerformers

bigdecimal

The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

brandedSearchesCategoryMedian

bigdecimal

shoppers that searched for the peer median, but did not further engage or purchase from peer median and [categoryNodePath] in the [lookBackPeriod]

brandedSearchesCategoryTopPerformers

bigdecimal

shoppers that searched for the avg. of the top 95th - 99th percent of peers, and [categoryNodePath] but did not further engage or purchase from the Top Performers in the [lookBackPeriod]

brandedSearchesOnly

bigdecimal

shoppers that searched for [Brand Name] but did not further engage or purchase from [Brand Name] and [categoryNodePath] in the [lookBackPeriod]

considerationIndex

bigdecimal

Consideration Index measures actual on-Amazon audience signals reflecting consideration for your brand in the short and long term, across the whole on-Amazon audience. The percentile lets you know how the consideration activity for your brand compares to that of your peers

customerConversionRate

bigdecimal

percentage of shoppers moving from "considering" [Brand Name] in the [categoryNodePath] to "purchased" in the [lookBackPeriod]

customerConversionRateCategoryMedian

bigdecimal

percentage of shoppers moving from "considering" the peer median in the [categoryNodePath] to "purchased" in the [lookBackPeriod]

customerConversionRateCategoryTopPerformers

bigdecimal

percentage of shoppers moving from "considering" the average of the top 95th-99th percent of peers in the [categoryNodePath] to "purchased" in the l[lookBackPeriod]

engagedShopperRateCategoryMedianLowerBound

bigdecimal

Lower bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchased from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category for the median peers

engagedShopperRateCategoryMedianUpperBound

bigdecimal

Upper bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category for the median peers

engagedShopperRateCategoryTopPerformersLowerBound

bigdecimal

Lower bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame by the total unique shoppers with 1+ detail page view in the selected category for the top 95th-99th percent of peers

engagedShopperRateCategoryTopPerformersUpperBound

bigdecimal

Upper bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category for the top 95th-99th percent of peers

engagedShopperRateLowerBound

bigdecimal

Lower bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from int the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category

engagedShopperRateUpperBound

bigdecimal

Upper bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category

highValueCustomers

bigdecimal

top 10% of sales contributing shoppers for

highValueCustomersCategoryMedian

bigdecimal

top 10% of sales contributing shoppers for peer median in [categoryNodePath] in [lookBackPeriod]

highValueCustomersCategoryTopPerformers

bigdecimal

The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category

highValueCustomersReturnOnEngagement

bigdecimal

The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category

highValueCustomersROECategoryMedian

bigdecimal

The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category

newToBrandCustomerRate

bigdecimal

share of customers that had not purchased [Brand Name] products in the last 12 months, but did so in the [lookBackPeriod]

newToBrandCustomerRateCategoryMedian

bigdecimal

share of customers that had not purchased peer median products in the last 12 months, but did so in the [lookBackPeriod]

newToBrandCustomerRateCategoryTopPerformers

bigdecimal

share of customers that had not purchased average of the top 95th-99th percent of peers products in the last 12 months, but did so in the [lookBackPeriod]

salesIndex

bigdecimal

Sales Index represents actual on-Amazon sales in the short term and long term, across the whole on-Amazon audience. The percentile lets you know how your sales compare to that of your peers

viewedDetailPageCategoryMedian

bigdecimal

shoppers that viewed the detail page only of peer median in [categoryNodePath] in [lookBackPeriod]

viewedDetailPageCategoryTopPerformers

bigdecimal

shoppers that viewed the detail page only of avg. of the top 95th - 99th percent of peers in [categoryNodePath] in [lookBackPeriod]

viewedDetailPageOnly

bigdecimal

shoppers that viewed detail page only of [Brand Name] in [categoryNodePath] in [lookBackPeriod]

viewedDetailPageOnlyReturnOnEngagement

bigdecimal

The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

viewedDetailPageROECategoryMedian

bigdecimal

The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

viewedDetailPageROECategoryTopPerformers

bigdecimal

The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category

profileId

long

Profile ID

adGroupId

long

The idenitifier of the ad group

campaignId

long

The identifier of the campaign associated with the ad group

name

string

The name of the ad group

profileId

long

Profile ID

code

string

The enumerated response code: - SUCCESS - The request was successful. The 'asinList' field includes all available ASINs. - INVALID_ARGUMENT - The request was not successful because the address was not for a valid landing page. - BAD_GATEWAY - The request failed because the landing page at the specified address did not have any ASINs

description

string

profileId

long

Profile ID

assetID

string

The identifier of an asset associated with a store

mediaType

string

name

string

The name of the asset

url

string

The address where the asset is stored

profileId

long

Profile ID

recommendation_type

string

code

string

An enumerated response code

details

string

A human-readable description of the enumerated response code in the 'code' field

keywordIndex

bigdecimal

Correlates the keyword to the keyword array index specified in the request

keyword_keywordText

string

The keyword text

keyword_matchType

string

Match Type

keyword_type

string

The match type, one of the following: broad, exact, phrase

keyword_value

string

The text of the keyword

recommendationId

string

The identifier of the target bid recommendation

recommendedBid_rangeEnd

bigdecimal

recommendedBid_rangeStart

bigdecimal

recommendedBid_recommended

bigdecimal

targetsIndex

bigdecimal

Correlates the keyword to the keyword array index specified in the request

targets_type

string

One of the following: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs

targets_value

string

The text of the targeting expression

profileId

long

Profile ID

id

long

The Brand identifier

name

string

The Brand name

profileId

long

Profile ID

brandEntityId

string

The Brand entity identifier

brandId

string

The Brand identifier

brandRegistryName

string

The Brand name

profileId

long

Profile ID

campaignId

long

The campaign identifier

name

string

The name of the campaign. This name must be unique to the Amazon Advertising account to which the campaign is associated. Maximum length of the string is 128 characters

startDate

date

The start date for the campaign. If this field is not set to a value, the current date is used

endDate

date

The end date for the campaign. Must be greater than the value for 'startDate'. If not specified, the campaign has no end date and runs continuously

bidMultiplier

bigdecimal

A bid multiplier. Note that this field can only be set when 'bidOptimization' is set to false. Value is a percentage to two decimal places. Example: If set to -30.00 for a $5.00 bid, the resulting bid is $3.00

bidOptimization

boolean

Set to 'true' to allow Amazon to automatically optimize bids for placements below top of search

brandEntityId

string

The brand entity identifier. Note that this field is required for sellers

budget

bigdecimal

The budget amount associated with the campaign

budgetType

string

Note that for the lifetime budget type, 'startDate' and 'endDate' must be specified. The lifetime budget range is from 100 to 20,000,000 and daily budget range is 1 to 1,000,000 by default for most marketplaces. For the JP marketplace, the lifetime budget range is fromt 10,000 to 2,000,000,000, and the daily budget range is 100 to 21,000,000

creative_asins

string

An array of ASINs associated with the creative

creative_brandLogoAssetID

string

The identifier of the brand logo image from the Store assets library

creative_brandLogoUrl

string

The address of the hosted image

creative_brandName

string

A brand name. Maximum length is 30 characters

creative_headline

string

The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters

creative_shouldOptimizeAsins

boolean

Note that this field is supported only in the US and UK marketplaces. Set to true to have Amazon show other products from your landing page in the advertisement if they are more relevant to the shopper's search. Set to false to use the ASINs specified in the 'asins' field. Do not specify in unsupported marketplaces

landingPage_asins

string

An array of ASINs used to generate a simple landing page. The response includes the URL of the generated simple landing page. Do not include this property in the request if the 'url' property is also included, these properties are mutually exclusive

landingPage_pageType

string

landingPage_url

string

"URL of a Store page. Vendors may also specify the URL of a custom landing page. If a custom URL is specified, the landing page must include include the ASINs of at least three products that are advertised as part of the campaign. Do not include this property in the request if the 'asins' property is also included, these properties are mutually exclusive."

portfolioId

long

The identifier of the portfolio to which the campaign is associated

servingStatus

string

One of the following : asinNotBuyable, billingError, ended, landingPageNotAvailable, outOfBudget, paused, pendingReview, ready, rejected, running, scheduled, terminated

state

string

profileId

long

Profile ID

campaignId

long

The campaign identifie

moderationStatus

string

One of the following : APPROVED, IN_PROGRESS, REJECTED

etaForModeration

timestamp

Expected date and time by which moderation will be complete

policyDescription

string

A human-readable description of the policy

policyLinkUrl

string

Address of the policy documentation. Follow the link to learn more about the specified policy

asinEvidences_asin

string

The ASIN that violates the specified policy

imageEvidences_violatingImageCrop_height

integer

The height of the content that violates the specfied policy within the image

imageEvidences_violatingImageCrop_topLeftX

integer

The top left X-coordinate of the content that violates the specfied policy within the image

imageEvidences_violatingImageCrop_topLeftY

integer

The top left Y-coordinate of the content that violates the specfied policy within the image

imageEvidences_violatingImageCrop_width

integer

The width of the content that violates the specfied policy within the image

moderatedComponent

string

The ad component that includes the text that violates the specified policy

reviewedImageUrl

string

Address of the image reviewed during moderation

reviewedText

string

The specific text reviewed during moderation

textEvidences

string

The specific text determined to violate the specified policy in 'reviewedText'

profileId

long

Profile ID

draftCampaignId

long

The identifier of the draft campaign

name

string

The name of the draft campaign. Maximum 128 characters. Duplicate campaign names are not allowed

startDate

date

The start date for the campaign. If this field is not set to a value, the current date is used

endDate

date

The end date for the campaign. Must be greater than the value for 'startDate'. If not specified, the campaign has no end date and runs continuously

bidMultiplier

bigdecimal

A bid multiplier. Note that this field can only be set when 'bidOptimization' is set to false. Value is a percentage to two decimal places. Example: If set to -30.00 for a $5.00 bid, the resulting bid is $3.00

bidOptimization

boolean

Set to 'true' to allow Amazon to automatically optimize bids for placements below top of search

brandEntityId

string

The brand entity identifier. Note that this field is required for sellers

budget

bigdecimal

The budget associated with the draft campaign

budgetType

string

Note that for the lifetime budget type, 'startDate' and 'endDate' must be specified. The lifetime budget range is from 100 to 20,000,000 and daily budget range is 1 to 1,000,000 by default for most marketplaces. For the JP marketplace, the lifetime budget range is fromt 10,000 to 2,000,000,000, and the daily budget range is 100 to 21,000,000

creative_asins

string

An array of ASINs associated with the creative

creative_brandLogoAssetID

string

The identifier of the brand logo image from the Store assets library

creative_brandLogoUrl

string

The address of the hosted image

creative_brandName

string

A brand name. Maximum length is 30 characters

creative_headline

string

The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters

creative_shouldOptimizeAsins

boolean

Note that this field is supported only in the US and UK marketplaces. Set to true to have Amazon show other products from your landing page in the advertisement if they are more relevant to the shopper's search. Set to false to use the ASINs specified in the 'asins' field. Do not specify in unsupported marketplaces

landingPage_asins

string

An array of ASINs used to generate a simple landing page. The response includes the URL of the generated simple landing page. Do not include this property in the request if the 'url' property is also included, these properties are mutually exclusive

landingPage_pageType

string

landingPage_url

string

"URL of a Store page. Vendors may also specify the URL of a custom landing page. If a custom URL is specified, the landing page must include include the ASINs of at least three products that are advertised as part of the campaign. Do not include this property in the request if the 'asins' property is also included, these properties are mutually exclusive."

portfolioId

long

The identifier of the Portfolio to which the draft campaign is associated

profileId

long

Profile ID

matchType

string

The match type

recommendationId

string

A recommendation identifier that describes the suggested action for the recommendation

value

string

Recommended keyword value

profileId

long

Profile ID

adGroupId

long

The identifier of the ad group associated with the keyword

bid

bigdecimal

The bid associated with the keyword

campaignId

long

The identifier of the campaign associated with the keyword

keywordId

long

The keyword identifier

keywordText

string

The keyword text. The maximum number of words for this string is 10

matchType

string

The match type. For more information, see match types in the Amazon Advertising support center

state

string

Newly created SB keywords are in a default state of 'draft' before transitioning to a 'pending' state for moderation. After moderation, the keyword will be in an enabled state

profileId

long

Profile ID

adGroupId

long

The identifier of the ad group associated with the keyword

campaignId

long

The identifier of the campaign associated with the keyword

keywordId

long

The keyword identifier

keywordText

string

The keyword text. The maximum number of words for this string is 10

matchType

string

The negative match type. For more information, see negative keyword match types in the Amazon Advertising support center

state

string

Newly created SB keywords are in a default state of 'draft' before transitioning to a 'pending' state for moderation. After moderation, the keyword will be in an enabled state

profileId

long

Profile ID

adGroupId

long

The identifier of the ad group to which the target is associated

bid

bigdecimal

The bid associated with the keyword

campaignId

long

The identifier of the campaign to which the target is associated

expressions_type

string

One of the following: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs

expressions_value

string

The text of the targeting expression

resolvedExpressions_type

string

One of the following: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs

resolvedExpressions_value

string

The human-readable target text

state

string

One of the following: enabled, paused, pending, archived, draft

targetId

long

The target identifier

profileId

long

Profile ID

recommendedTargetAsin

string

profileId

long

Profile Id

reportDate

date

The date of the performance report

isVideo

boolean

From Sponsored Brands video report

placement

string

The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears

query

string

The optional dimension on which to segment a keyword report. This is also referred to as the search terms report

adGroupId

long

Unique AdGroup ID

adGroupName

string

Unique AdGroup name

campaignBudget

bigdecimal

The campaign budget

campaignBudgetType

string

One of: daily or lifetime

campaignId

long

Unique campaign ID

campaignName

string

Advertiser created campaign name

campaignRuleBasedBudget

bigdecimal

The value of the rule-based budget

campaignStatus

string

Current status of the campaign

keywordId

long

Keyword ID

keywordBid

bigdecimal

User-set bid value for keyword

keywordStatus

string

Keyword state

keywordText

string

Keyword or phrase used in bid

applicableBudgetRuleId

string

The identifier of the active rule

applicableBudgetRuleName

string

The name of the active rule

targetId

long

The product target identifier

targetingExpression

string

The product targeting expression. Not available for search term report

targetingText

string

The product targeting text. Not available for search term report

targetingType

string

The product targeting type. One of: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs

searchTermImpressionRank

string

Search term impression rank provides account-level ad-attributed impression rank for search terms

searchTermImpressionShare

string

Search term impression share provides account-level ad-attributed impression share for search terms

matchType

string

One of: broad, phrase, or exact

attributedConversions14d

bigdecimal

Number of attributed conversion events occurring within 14 days of click on ad

attributedConversions14dSameSKU

bigdecimal

Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised

attributedDetailPageViewsClicks14d

bigdecimal

The number of detail page view conversions attributed to ad click-throughs within 14 days

attributedOrderRateNewToBrand14d

bigdecimal

The number of new-to-brand orders relative to the number of clicks

attributedOrdersNewToBrand14d

bigdecimal

The number of first-time orders for products within the brand over a one-year lookback window

attributedOrdersNewToBrandPercentage14d

bigdecimal

The percentage of total orders that are new-to-brand orders

attributedSales14d

bigdecimal

Number of attributed sales occurring within 14 days of click on an ad

attributedSales14dSameSKU

bigdecimal

Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised

attributedSalesNewToBrand14d

bigdecimal

The total sales of new-to-brand orders

attributedSalesNewToBrandPercentage14d

bigdecimal

The percentage of total sales of new-to-brand purchases

attributedUnitsOrderedNewToBrand14d

bigdecimal

The number of units from first-time orders for products within the brand over a one-year lookback window

attributedUnitsOrderedNewToBrandPercentage14d

bigdecimal

The percentage of total units that are units from new-to-brand orders

clicks

bigdecimal

Total ad clicks

cost

bigdecimal

Total cost of all clicks

dpv14d

bigdecimal

Number of attributed detail page views occurring within 14 days of click on an ad

impressions

bigdecimal

Total ad impressions

topOfSearchImpressionShare

bigdecimal

The percentage of top-of-search impressions earned out of all the top-of-search impressions that were eligible for a given date range. Various factors determine the eligibility for an impression including campaign status and targeting status

unitsSold14d

bigdecimal

Number of attributed units sold occurring within 14 days of click on an ad

viewableImpressions

bigdecimal

Views is the number of impressions that met the MRC viewability standard (50% viewable with 2 seconds playback completed)

videoFirstQuartileViews

bigdecimal

The number of impressions where the video was viewed to 25%

videoMidpointViews

bigdecimal

The number of impressions where the video was viewed to 50%

videoThirdQuartileViews

bigdecimal

The number of impressions where the video was viewed to 75%

videoCompleteViews

bigdecimal

The number of impressions where the video was viewed to 100%

video5SecondViews

bigdecimal

The number of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter)

video5SecondViewRate

bigdecimal

The percentage of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter)

videoUnmutes

bigdecimal

The number of impressions where a shopper unmuted the video

vtr

bigdecimal

View-through-rate (views/impressions)

vctr

bigdecimal

Clicks-through-rate for views (clicks/views)

errorMessage

string

Error message if any problem happened

profileId

long

Profile ID

id

long

The category identifier

isTargetable

boolean

Set to 'true' if the category can be targeted in a targeting expression, and 'false' if not

name

string

The category name

path

string

The path of the category within the category catalogue

profileId

long

Profile ID

adGroupId

long

The identifier of the ad group to which the target is associated

bid

bigdecimal

The bid associated with the keyword

campaignId

long

The identifier of the campaign to which the target is associated

expressions_type

string

One of the following: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs

expressions_value

string

The text of the targeting expression

resolvedExpressions_type

string

One of the following: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs

resolvedExpressions_value

string

The human-readable target text

state

string

One of the following: enabled, paused, pending, archived, draft

targetId

long

The target identifier

profileId

long

Profile ID

campaignId

long

ID of the campaign

name

string

Name of the campaign

targetingType

string

Differentiates between a keyword-targeted and automatically targeted campaign

state

string

Advertiser-specified state of the campaign

dailyBudget

bigdecimal

Daily budget for the campaign

startDate

date

The date the campaign will go or went live

endDate

date

The optional date the campaign will stop running

premiumBidAdjustment

boolean

When enabled, Amazon will increase the default bid for your ads that are eligible to appear in this placement

placement

string

Ad placement. Only returned when segment is set to placement

creationDate

timestamp

The date the campaign was created

lastUpdatedDate

timestamp

The date the campaign was last updated

servingStatus

string

The computed status, accounting for campaign out of budget, policy violations, etc

portfolioId

long

The ID of the portfolio

report_source

string

Source report name

tactic

string

Advertising tactic associated with campaign for sponsored display report

profileId

long

Profile Id

reportDate

date

The date of the performance report

campaignName

string

Unique name of the campaign

campaignId

long

Unique numerical ID of the campaign

campaignStatus

string

Current status of the campaign

campaignBudget

bigdecimal

Total budget allotted to the campaign

campaignBudgetType

string

One of: daily or lifetime

adGroupName

string

Unique name of the ad group

adGroupId

long

Unique numerical ID of the ad group

adid

long

The unique numerical ID of the ad

keywordId

long

ID of the keyword used in bid

keywordText

string

Text of the keyword or phrase used in bid

keywordStatus

string

Keyword state

keywordBid

bigdecimal

User-set bid value for keyword

matchType

string

Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact

placement

string

The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears

query

string

The optional dimension on which to segment a keyword report. This is also referred to as the search terms report

targetId

long

The identifier of the targeting expression used in a bid

targetingExpression

string

A string representation of your expression object in targeting clauses

targetingText

string

A resolved string representation of your expression object in targeting clauses

targetingType

string

Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED

clicks

bigdecimal

Total number of ad clicks associated with the campaign

cost

bigdecimal

The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC)

currency

string

The currency code associated with the campaign

impressions

bigdecimal

Total number of ad impressions

asin

string

The ASIN that is being advertised

sku

string

The SKU that is being advertised

attributedConversions1d

bigdecimal

Total number of attributed conversion events occuring within 24 hours of ad click

attributedConversions1dSameSKU

bigdecimal

Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent

attributedSales1d

bigdecimal

Total number of attributed sales occuring within 24 hours of ad click

attributedSales1dSameSKU

bigdecimal

Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent

attributedUnitsOrdered1d

bigdecimal

Total number of attributed units ordered within 24 hours of ad click

attributedUnitsOrdered1dSameSKU

bigdecimal

Total number of units ordered within 24 hours of ad click where the purchased SKU was the same as the SKU advertised

attributedConversions7d

bigdecimal

Total number of attributed conversion events occuring within 7 days of ad click

attributedConversions7dSameSKU

bigdecimal

Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent

attributedSales7d

bigdecimal

Total number of attributed sales occuring within 7 days of ad click

attributedSales7dSameSKU

bigdecimal

Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent

attributedUnitsOrdered7d

bigdecimal

Total number of attributed units ordered within 7 days of ad click

attributedConversions14d

bigdecimal

Total number of attributed conversion events occuring within 14 days of ad click

attributedConversions14dSameSKU

bigdecimal

Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent

attributedDPV14d

bigdecimal

Number of attributed detail page views occuring within 14 days of click on an ad

attributedDetailPageViewsClicks14d

bigdecimal

The number of detail page view conversions attributed to ad click-throughs within 14 days

attributedOrderRateNewToBrand14d

bigdecimal

The number of new-to-brand orders relative to the number of clicks

attributedOrdersNewToBrand14d

bigdecimal

The number of first-time orders for products within the brand over a one-year lookback window

attributedOrdersNewToBrandPercentage14d

bigdecimal

The percentage of total orders that are new-to-brand orders

attributedSales14d

bigdecimal

Number of attributed sales occurring within 14 days of click on an ad

attributedSales14dSameSKU

bigdecimal

Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent

attributedSalesNewToBrand14d

bigdecimal

The total sales of new-to-brand orders

attributedSalesNewToBrandPercentage14d

bigdecimal

The percentage of total sales of new-to-brand purchases

attributedUnitsOrdered14d

bigdecimal

Total number of attributed units ordered within 14 days of ad click

attributedUnitsOrderedNewToBrand14d

bigdecimal

The number of units from first-time orders for products within the brand over a one-year lookback window

attributedUnitsOrderedNewToBrandPercentage14d

bigdecimal

The percentage of total units that are units from new-to-brand orders

attributedUnitsSold14d

bigdecimal

Number of attributed units sold occurring within 14 days of click on an ad

dpv14d

bigdecimal

Number of attributed detail page views occurring within 14 days of click on an ad

attributedConversions30d

bigdecimal

Total number of attributed conversion events occuring within 30 days of ad click

attributedConversions30dSameSKU

bigdecimal

Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent

attributedSales30d

bigdecimal

Total number of attributed sales occuring within 30 days of ad click

attributedSales30dSameSKU

bigdecimal

Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent

attributedUnitsOrdered30d

bigdecimal

Total number of attributed units ordered within 30 days of ad click

isVideo

boolean

From Sponsored Brands video report

errorMessage

string

Error message if any problem happened

profileId

long

Profile ID

adGroupId

long

The identifier of the ad group

campaignId

long

The identifier of the campaign that this ad group is associated with

defaultBid

bigdecimal

The amount of the default bid associated with the ad group. Used if no bid is specified

name

string

The name of the ad group

servingStatus

string

The status of the ad group

state

string

The delivery state of the ad group

creationDate

timestamp

Epoch time the ad group was created

lastUpdatedDate

timestamp

Epoch time any property in the ad group was last updated

profileId

long

Profile ID

campaignId

long

The identifier of the campaign

startDate

date

The start date of the campaign. The date must be today or in the future

endDate

date

The end date of the campaign

budget

bigdecimal

The amount of the budget

budgetType

string

The time period over which the amount specified in the 'budget' property is allocated

costType

string

deliveryProfile

string

name

string

The name of the campaign

servingStatus

string

The status of the campaign

state

string

The state of the campaign

tactic

string

The advertising tactic associated with the campaign. The following table lists available tactic names: T00001, T00020, remarketing

creationDate

timestamp

Epoch date the campaign was created

lastUpdatedDate

timestamp

Epoch date of the last update to any property associated with the campaign

profileId

long

Profile ID

adId

long

The identifier of the ad

adGroupId

long

The identifier of the ad group associated with the ad

asin

string

The ASIN of the product being advertised

campaignId

long

The identifier of the campaign associated with the ad

servingStatus

string

The status of the product ad

sku

string

The SKU of the product being advertised

state

string

The state of the product ad

creationDate

timestamp

Epoch date the product ad was created

lastUpdatedDate

timestamp

Epoch date of the last update to any property associated with the product ad

profileId

long

Profile Id

reportDate

date

The date of the performance report

tactic

string

The advertising tactic associated with the campaign

adGroupId

long

Unique numerical ID of the ad group.

adGroupName

string

The name of the ad group as entered by the advertiser.

adId

long

Unique numerical ID of the ad.

applicableBudgetRuleId

string

The ID associated to the active budget rule for Sponsored Brands campaigns. For more information, see Including budget rules values in Reports.

applicableBudgetRuleName

string

The name associated to the active budget rule for Sponsored Brands campaigns. For more information, see Including budget rules values in Reports.

asin

string

The ASIN associated to an advertised product.

attributedBrandedSearches14d

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click.

attributedConversions14d

integer

Number of attributed conversion events occurring within 14 days of an ad click.

attributedConversions14dOtherSKU

integer

The total number of attributed conversion events occurring within 14 days of an ad click where the purchased SKU was different from the SKU advertised.

attributedConversions14dSameSKU

integer

Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised.

attributedConversions1d

integer

Number of attributed conversion events occurring within 24 hours of ad click.

attributedConversions1dSameSKU

integer

Number of attributed conversion events occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised.

attributedConversions30d

integer

Number of attributed conversion events occurring within 30 days of an ad click.

attributedConversions30dOtherSKU

integer

The total number of attributed conversion events occurring within 30 days of an ad click where the purchased SKU was different from the SKU advertised.

attributedConversions30dSameSKU

integer

Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised.

attributedConversions7d

integer

Number of attributed conversion events occurring within seven days of an ad click.

attributedConversions7dOtherSKU

integer

The total number of attributed conversion events occurring within seven days of an ad click where the purchased SKU was different from the SKU advertised.

attributedConversions7dSameSKU

integer

Number of attributed conversion events occurring within seven days of ad click where the purchased SKU was the same as the SKU advertised.

attributedDPV14d

integer

This metric is in beta. Number of attributed detail page views occurring within 14 days of ad click.

attributedOrdersNewToBrand14d

integer

The number of first-time orders for brand products over a one-year lookback window. Not available for book vendors.

attributedSales14d

bigdecimal

Total value of sales occurring within 14 days of an ad click.

attributedSales14dOtherSKU

bigdecimal

Total value of sales occurring within 14 days of an ad click where the purchased SKU was different from the SKU advertised.

attributedSales14dSameSKU

bigdecimal

Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised.

attributedSales1d

bigdecimal

Total value of sales occurring within 24 hours of an ad click.

attributedSales1dOtherSKU

bigdecimal

Total value of sales occurring within 24 hours of an ad click where the purchased SKU was different from the SKU advertised.

attributedSales1dSameSKU

bigdecimal

Total value of sales occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised.

attributedSales30d

bigdecimal

Total value of sales occurring within 30 days of an ad click.

attributedSales30dOtherSKU

bigdecimal

Total value of sales occurring within 30 days of an ad click where the purchased SKU was different from the SKU advertised.

attributedSales30dSameSKU

bigdecimal

Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised.

attributedSales7d

bigdecimal

Total value of sales occurring within seven days of an ad click.

attributedSales7dOtherSKU

bigdecimal

Total value of sales occurring within seven days of an ad click where the purchased SKU was different from the SKU advertised.

attributedSales7dSameSKU

bigdecimal

Total value of sales occurring within seven days of ad click where the purchased SKU was the same as the SKU advertised.

attributedSalesNewToBrand14d

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors.

attributedUnitsOrdered14d

integer

Total number of units ordered within 14 days of an ad click.

attributedUnitsOrdered14dOtherSKU

integer

Total number of units ordered within 14 days of an ad click where the purchased SKU was different from the SKU advertised.

attributedUnitsOrdered1d

integer

Total number of units ordered within 24 hours of an ad click.

attributedUnitsOrdered1dOtherSKU

integer

Total number of units ordered within 24 hours of an ad click where the purchased SKU was different from the SKU advertised.

attributedUnitsOrdered30d

integer

Total number of units ordered within 30 days of an ad click.

attributedUnitsOrdered30dOtherSKU

integer

Total number of units ordered within 30 days of an ad click where the purchased SKU was different from the SKU advertised.

attributedUnitsOrdered7d

integer

Total number of units ordered within 7 days of an ad click.

attributedUnitsOrdered7dOtherSKU

integer

Total number of units ordered within seven days of an ad click where the purchased SKU was different from the SKU advertised.

attributedUnitsOrderedNewToBrand14d

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors.

avgImpressionsFrequency

bigdecimal

Average number of times unique users were exposed to an ad over the lifetime of the campaign.

bidOptimization

string

Bid optimization for Sponsored Display ad groups. For vCPM campaigns, the value is always reach. For CPC campaigns, value is either clicks or conversions.

campaignBudget

bigdecimal

Total budget allocated to the campaign.

campaignId

long

Unique numerical ID of a campaign.

campaignName

string

The name of the campaign as entered by the advertiser.

campaignRuleBasedBudget

bigdecimal

The value of the rule-based budget for Sponsored Brands campaigns. For more information, see Including budget rules values in Reports.

campaignStatus

string

Current status of the campaign. One of active, paused, or archived.

clicks

integer

Total number of ad clicks.

cost

bigdecimal

Total cost of ad clicks.

costType

string

Determines how the campaign will bid and charge. One of vCPM (cost per thousand viewable impressions) or CPC (cost per click). Only relevant for Sponsored Display campaigns.

cumulativeReach

integer

Total number of unique users exposed to an ad from either a campaign, ad group, or product ad over the lifetime of the campaign or the past six months, whichever is shorter. This metric is updated daily.

currency

string

The currency code associated with the campaign.

impressions

integer

Total number of ad impressions.

otherAsin

string

Represents a product that was purchased after an ad click but has a different SKU/ASIN that what was advertised.

sku

string

The SKU being advertised. Not available for vendors.

targetId

long

The identifier of the targeting expression.

targetingExpression

string

A string representation of the expression object used in the targeting clause.

targetingText

string

The text used in the targeting expression.

targetingType

string

The type of targeting used in the expression.

vctr

bigdecimal

Click-through rate for views (clicks divided by views).

videoCompleteViews

integer

The number of impressions where the video was viewed to 100%.

videoFirstQuartileViews

integer

The number of impressions where the video was viewed to 25%.

videoMidpointViews

integer

The number of impressions where the video was viewed to 50%.

videoThirdQuartileViews

integer

The number of impressions where the video was viewed to 75%.

videoUnmutes

integer

The number of impressions where a customer unmuted the video.

viewAttributedBrandedSearches14d

integer

For Sponsored Display vCPM campaigns, this is the number of searches that included the name of your brand occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedBrandedSearches14d.

viewAttributedConversions14d

integer

For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedConversions14d.

viewAttributedConversions14dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions14dOtherSKU.

viewAttributedConversions1dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 24 hours of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions1dOtherSKU.

viewAttributedConversions30dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 30 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions30dOtherSKU.

viewAttributedConversions7dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within seven days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions7dOtherSKU.

viewattributedDPV14d

integer

This metric is in beta. For Sponsored Display vCPM campaigns, the total number of attributed detail page views occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedDPV14d.

viewAttributedOrdersNewToBrand14d

integer

For Sponsored Display vCPM campaigns, the number of first-time orders for brand products over a one-year lookback window. Not available for book vendors. For CPC campaigns, this value is equal to attributedOrdersNewToBrand14d.

viewAttributedSales14d

bigdecimal

For Sponsored Display vCPM campaigns, the total value of sales occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedSales14d.

viewAttributedSales14dOtherSKU

bigdecimal

For Sponsored Display vCPM campaigns, the total value of sales occurring within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales14dOtherSKU.

viewAttributedSales1dOtherSKU

bigdecimal

For Sponsored Display vCPM campaigns, the total value of sales occurring within 24 hours of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales1dOtherSKU.

viewAttributedSales30dOtherSKU

bigdecimal

For Sponsored Display vCPM campaigns, the total value of sales occurring within 30 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales30dOtherSKU.

viewAttributedSales7dOtherSKU

bigdecimal

For Sponsored Display vCPM campaigns, the total value of sales occurring within seven days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales7dOtherSKU.

viewAttributedSalesNewToBrand14d

bigdecimal

For Sponsored Display vCPM campaigns, the total value of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors. For CPC campaigns, this value is equal to attributedSalesNewToBrand14d.

viewAttributedUnitsOrdered14d

integer

For Sponsored Display vCPM campaigns, the total number of units ordered within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedUnitsOrdered14d.

viewAttributedUnitsOrdered14dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of units ordered within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered14dOtherSKU.

viewAttributedUnitsOrdered1dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of units ordered within 24 hours of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered1dOtherSKU.

viewAttributedUnitsOrdered30dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of units ordered within 30 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered30dOtherSKU.

viewAttributedUnitsOrdered7dOtherSKU

integer

For Sponsored Display vCPM campaigns, the total number of units ordered within seven days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered7dOtherSKU.

viewAttributedUnitsOrderedNewToBrand14d

integer

For Sponsored Display vCPM campaigns, the total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors. For CPC campaigns, this value is equal to attributedUnitsOrderedNewToBrand14d.

viewImpressions

integer

The total number of viewable impressions. Only relevant for Sponsored Display vCPM campaigns.

vtr

bigdecimal

View-through rate (vtr). Views divided by impressions.

errorMessage

string

Error message if any problem happened

profileId

long

Profile ID

asins

string

A list of ASINs

readinessStatus

string

One of the following: HIGH, MEDIUM, LOW

profileId

long

Profile ID

targetId

long

The identifier of the targeting expression used in a bid

adGroupId

long

The identifier of the ad group

bid

bigdecimal

If a value for 'bid' is specified, it overrides the current adGroup bid. Note that this field is ignored for negative targeting clauses

expression

string

The targeting expression to match against

resolvedExpression

string

servingStatus

string

The status of the target

state

string

One of the following: enabled, paused, archived

creationDate

timestamp

Epoch date the target was created

lastUpdatedDate

timestamp

Epoch date of the last update to any property associated with the target

profileId

long

Profile ID

timestamp

timestamp

Timestamp

changeType

string

Change type for Entity types

entityType

string

Entity type

entityId

string

Entity id

newValue

string

New value

previousValue

string

Previous value

metadata_productTargetingType

string

Product targeting type

metadata_programType

string

Program type

metadata_campaignId

string

Campaign id

metadata_campaignBudgetType

string

Campaign budget type

metadata_keywordType

string

Keyword type

metadata_predefinedTarget

string

Predefined target

metadata_keyword

string

Keyword

metadata_adAsin

string

Ad asin

metadata_targetingExpression

string

Targeting expression

metadata_placementGroupPosition

string

Placement group position

metadata_negativeTargetingType

string

Negative targeting type

metadata_adGroupId

string

AdGroup id

profileId

long

Profile ID

fromDate

date

From date

toDate

date

To date

id

string

Invoice Id

invoiceDate

date

Invoice date

dueDate

date

Due date

status

string

Invoice Status: - ISSUED: An invoice is issued when its charges are finalized and tax is computed on the total amount; - PAID_IN_PART: When a partial payment is received, the invoice status will change to paid in part; - PAID_IN_PART: One full payment has been received, the invoice will be paid in full; - WRITTEN_OFF: If an invoice is written off because of an error, the status will be updated to written off

purchaseOrderNumber

string

Account-level purchase order number

paymentMethod

string

Payment method: CREDIT_CARD, ELECTRONIC_FUNDS_TRANSFER, DEDUCT_FROM_PAYMENT, UNIFIED_BILLING

amountDue_amount

bigdecimal

Amount due

amountDue_currencyCode

string

The currency used for all monetary values for entities under this profile

taxAmountDue_amount

bigdecimal

Amount due

taxAmountDue_currencyCode

string

The currency used for all monetary values for entities under this profile

remainingAmountDue_amount

bigdecimal

Remaining Amount due

remainingAmountDue_currencyCode

string

The currency used for all monetary values for entities under this profile

remainingTaxAmountDue_amount

bigdecimal

Amount due

remainingTaxAmountDue_currencyCode

string

The currency used for all monetary values for entities under this profile

profileId

long

Profile ID

keywordId

long

Keyword ID

adGroupId

long

Ad group ID

campaignId

long

Campaign ID

keywordText

string

Keyword text

nativeLanguageKeyword

string

The unlocalized keyword text in the preferred locale of the advertiser

bid

bigdecimal

id associated with this keyword. Applicable to biddable match types only

matchType

string

Match type

state

string

State

servingStatus

string

Serving status

creationDate

timestamp

Creation date

lastUpdatedDate

timestamp

Last update date

profileId

long

Profile ID

adGroupId

long

Ad group ID

keywordText

string

Keyword text

matchType

string

Match type

profileId

long

Profile ID

managerAccountId

string

Id of the Manager Account

managerAccountName

string

The name given to a Manager Account

linkedAccounts_accountId

string

Id of the Amazon Advertising account

linkedAccounts_accountName

string

The name given to the Amazon Advertising account

linkedAccounts_accountType

string

Type of the Amazon Advertising account

linkedAccounts_marketplaceId

string

The identifier of the marketplace to which the account is associated. See this table for marketplaceId mappings

linkedAccounts_profileId

string

The identifier of a profile associated with the advertiser account. Note that this value is only populated for a subset of account types: [ SELLER, VENDOR, MARKETING_CLOUD ]. It will be null for accounts of other types

profileId

long

Profile ID

portfolioId

long

ID of the portfolio

name

string

Name of the portfolio

budget_amount

bigdecimal

Bdget amount

budget_currencyCode

string

Currency code of the budget

budget_policy

string

Policy of the portfolio

budget_startDate

date

Start date of the portfolio

budget_endDate

date

End date of the portfolio

inBudget

boolean

States if the portfolio is still within budget

state

string

Status of the portfolio

creationDate

timestamp

Date the portfolio was created

lastUpdatedDate

timestamp

Date the portfolio was last updated

servingStatus

string

Serving status of the portfolio

profileId

long

Profile ID

adId

long

ID of the product ad

campaignId

long

ID of the campaign to which this product ad belongs

adGroupId

long

ID of the ad group to which this product ad belongs

sku

string

SKU for the listed product to be advertised

asin

string

ASIN for the listed product to be advertised

state

string

Advertiser-specified state of the product ad

creationDate

timestamp

Date the ad group was created

lastUpdatedDate

timestamp

Date the ad group was last updated

servingStatus

string

Computed status, accounting for out of budget, policy violations, etc.

profileId

long

ID of the profile

countryCode

string

Country code identifying the publisher(s) on which ads will run

currencyCode

string

Currency used for all monetary values for entities under this profile

dailyBudget

bigdecimal

Optional budget shared by all entities created under this profile

timezone

string

Tz database time zone used for all date-based campaign management and reporting

marketplaceStringId

string

Identifier for the marketplace associated with this profile. This is the same identifier used by MWS

account_id

string

Identifier for the ID associated with this account

account_name

string

Identifier for the account name

account_type

string

account_subType

string

validPaymentMethod

string

profileId

long

ID of the profile

date

date

Date when the ad activity ocurred in the format YYYY-MM-DD

campaignId

long

The ID associated with a campaign

campaignName

string

The name associated with a campaign

campaignStatus

string

The status of a campaign

adGroupId

long

Unique numerical ID of the ad group

adGroupName

string

The name of the ad group as entered by the advertiser

addToCart

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad view or click

addToCartClicks

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad click

addToCartRate

bigdecimal

Calculated by divididing addToCart by impressions

addToList

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view or click. Use Total ATL to see all conversions for the brands' products

addToListFromClicks

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad click

adStatus

string

Status of the ad group.

brandedSearches

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click or view

brandedSearchesClicks

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click

campaignBudgetAmount

bigdecimal

Total budget allocated to the campaign

campaignBudgetCurrencyCode

string

The currency code associated with the campaign

campaignBudgetType

string

One of daily or lifetime

clicks

integer

Total number of clicks on an ad

cost

bigdecimal

Total cost of ad clicks

costType

string

Determines how the campaign will bid and charge. One of vCPM (cost per thousand viewable impressions) or CPC (cost per click).

detailPageViews

integer

Number of detail page views occurring within 14 days of an ad click or view

detailPageViewsClicks

integer

Number of detail page views occurring within 14 days of an ad click

eCPAddToCart

bigdecimal

Effect cost per add to cart, calculated by cost divided by add-to-cart

impressions

integer

Total number of ad impressions

newToBrandDetailPageViewRate

bigdecimal

Calculated by dividing newToBrandDetailPageViews / impressions

newToBrandDetailPageViews

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who either clicked or viewed an ad

newToBrandDetailPageViewsClicks

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who clicked an ad

newToBrandECPDetailPageView

bigdecimal

Effective cost per new-to-brand detail page view, calculated by cost divided by new-to-brand detail page view

newToBrandPurchases

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click or view. Not available for book vendors

newToBrandPurchasesClicks

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click. Not available for book vendors

newToBrandPurchasesPercentage

bigdecimal

The percentage of total orders that are new-to-brand orders within 14 days of an ad click. Not available for book vendors.

newToBrandPurchasesRate

bigdecimal

The percentage of total orders that are new-to-brand orders. Not available for book vendors

newToBrandSales

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandSalesClicks

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandSalesPercentage

bigdecimal

Percentage of total sales made up of new-to-brand purchases within 14 days of an ad click. Not available for book vendors. Same as newToBrandSalesPercentage14d

newToBrandUnitsSold

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandUnitsSoldClicks

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandUnitsSoldPercentage

bigdecimal

Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors. Same as newToBrandUnitsSoldPercentage14d

purchases

integer

Number of attributed conversion events occurring within 14 days of an ad click or view

purchasesClicks

integer

Number of attributed conversion events occurring within 14 days of an ad click

purchasesPromoted

integer

Number of attributed conversion events occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as purchasesSameSku14d

qualifiedBorrows

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

qualifiedBorrowsFromClicks

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrows

integer

Estimated royalty payment attributed to Kindle Unlimited users downloading the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrowsFromClicks

integer

Estimated royalty payment attributed to Kindle Unlimited users who clicked on the ad, downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

sales

bigdecimal

Total value of sales occurring within 14 days of an ad click or view.

salesClicks

bigdecimal

Total value of sales occurring within 14 days of an ad click.

salesPromoted

bigdecimal

Total value of sales occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as attributedSales14dSameSKU

unitsSold

integer

Number of attributed units sold within 14 days of an ad click or view

unitsSoldClicks

integer

Number of attributed units sold within 14 days of an ad click

video5SecondViewRate

bigdecimal

The percentage of impressions where the customer watched the complete video or 5 seconds of the video (whichever is shorter). Sponsored Brands video-only metric

video5SecondViews

integer

The number of impressions where the customer watched the complete video or 5 seconds (whichever is shorter). Sponsored Brands video-only metric

videoCompleteViews

integer

The number of impressions where the video was viewed to 100%

videoFirstQuartileViews

integer

The number of impressions where the video was viewed to 25%

videoMidpointViews

integer

The number of impressions where the video was viewed to 50%

videoThirdQuartileViews

integer

The number of impressions where the video was viewed to 75%

videoUnmutes

integer

The number of impressions where a customer unmuted the video

viewabilityRate

bigdecimal

View-through rate (vtr). Views divided by impressions

errorMessage

string

Error message if any problem happened

profileId

long

ID of the profile

date

date

Date when the ad activity ocurred in the format YYYY-MM-DD

campaignId

long

The ID associated with a campaign

campaignName

string

The name associated with a campaign

campaignStatus

string

The status of a campaign

adGroupId

long

Unique numerical ID of the ad group

adGroupName

string

The name of the ad group as entered by the advertiser

adId

long

Unique numerical ID of the ad

addToCart

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad view or click

addToCartClicks

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad click

addToCartRate

bigdecimal

Calculated by divididing addToCart by impressions

addToList

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view or click. Use Total ATL to see all conversions for the brands' products

addToListFromClicks

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad click

brandedSearches

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click or view

brandedSearchesClicks

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click

campaignBudgetAmount

bigdecimal

Total budget allocated to the campaign

campaignBudgetCurrencyCode

string

The currency code associated with the campaign

campaignBudgetType

string

One of daily or lifetime

clicks

integer

Total number of clicks on an ad

cost

bigdecimal

Total cost of ad clicks

costType

string

Determines how the campaign will bid and charge. One of vCPM (cost per thousand viewable impressions) or CPC (cost per click).

detailPageViews

integer

Number of detail page views occurring within 14 days of an ad click or view

detailPageViewsClicks

integer

Number of detail page views occurring within 14 days of an ad click

eCPAddToCart

bigdecimal

Effect cost per add to cart, calculated by cost divided by add-to-cart

impressions

integer

Total number of ad impressions

newToBrandDetailPageViewRate

bigdecimal

Calculated by dividing newToBrandDetailPageViews / impressions

newToBrandDetailPageViews

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who either clicked or viewed an ad

newToBrandDetailPageViewsClicks

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who clicked an ad

newToBrandECPDetailPageView

bigdecimal

Effective cost per new-to-brand detail page view, calculated by cost divided by new-to-brand detail page view

newToBrandPurchases

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click or view. Not available for book vendors

newToBrandPurchasesClicks

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click. Not available for book vendors

newToBrandPurchasesPercentage

bigdecimal

The percentage of total orders that are new-to-brand orders within 14 days of an ad click. Not available for book vendors.

newToBrandPurchasesRate

bigdecimal

The percentage of total orders that are new-to-brand orders. Not available for book vendors

newToBrandSales

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandSalesClicks

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandSalesPercentage

bigdecimal

Percentage of total sales made up of new-to-brand purchases within 14 days of an ad click. Not available for book vendors. Same as newToBrandSalesPercentage14d

newToBrandUnitsSold

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandUnitsSoldClicks

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandUnitsSoldPercentage

bigdecimal

Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors. Same as newToBrandUnitsSoldPercentage14d

purchases

integer

Number of attributed conversion events occurring within 14 days of an ad click or view

purchasesClicks

integer

Number of attributed conversion events occurring within 14 days of an ad click

purchasesPromoted

integer

Number of attributed conversion events occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as purchasesSameSku14d

qualifiedBorrows

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

qualifiedBorrowsFromClicks

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrows

integer

Estimated royalty payment attributed to Kindle Unlimited users downloading the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrowsFromClicks

integer

Estimated royalty payment attributed to Kindle Unlimited users who clicked on the ad, downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

sales

bigdecimal

Total value of sales occurring within 14 days of an ad click or view.

salesClicks

bigdecimal

Total value of sales occurring within 14 days of an ad click.

salesPromoted

bigdecimal

Total value of sales occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as attributedSales14dSameSKU

unitsSold

integer

Number of attributed units sold within 14 days of an ad click or view

unitsSoldClicks

integer

Number of attributed units sold within 14 days of an ad click

video5SecondViewRate

bigdecimal

The percentage of impressions where the customer watched the complete video or 5 seconds of the video (whichever is shorter). Sponsored Brands video-only metric

video5SecondViews

integer

The number of impressions where the customer watched the complete video or 5 seconds (whichever is shorter). Sponsored Brands video-only metric

videoCompleteViews

integer

The number of impressions where the video was viewed to 100%

videoFirstQuartileViews

integer

The number of impressions where the video was viewed to 25%

videoMidpointViews

integer

The number of impressions where the video was viewed to 50%

videoThirdQuartileViews

integer

The number of impressions where the video was viewed to 75%

videoUnmutes

integer

The number of impressions where a customer unmuted the video

viewabilityRate

bigdecimal

View-through rate (vtr). Views divided by impressions

viewableImpressions

integer

Number of impressions that met the Media Ratings Council (MRC) viewability standard. See viewability details at

https://advertising.amazon.com/library/guides/viewability

errorMessage

string

Error message if any problem happened

profileId

long

ID of the profile

date

date

Date when the ad activity ocurred in the format YYYY-MM-DD

campaignId

long

The ID associated with a campaign

campaignName

string

The name associated with a campaign

campaignStatus

string

The status of a campaign

addToCart

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad view or click

addToCartClicks

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad click

addToCartRate

bigdecimal

Calculated by divididing addToCart by impressions

addToList

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view or click. Use Total ATL to see all conversions for the brands' products

addToListFromClicks

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad click

brandedSearches

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click or view

brandedSearchesClicks

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click

campaignBudgetAmount

bigdecimal

Total budget allocated to the campaign

campaignBudgetCurrencyCode

string

The currency code associated with the campaign

campaignBudgetType

string

One of daily or lifetime

clicks

integer

Total number of clicks on an ad

cost

bigdecimal

Total cost of ad clicks

costType

string

Determines how the campaign will bid and charge. One of vCPM (cost per thousand viewable impressions) or CPC (cost per click).

detailPageViews

integer

Number of detail page views occurring within 14 days of an ad click or view

detailPageViewsClicks

integer

Number of detail page views occurring within 14 days of an ad click

eCPAddToCart

bigdecimal

Effect cost per add to cart, calculated by cost divided by add-to-cart

impressions

integer

Total number of ad impressions

newToBrandDetailPageViewRate

bigdecimal

Calculated by dividing newToBrandDetailPageViews / impressions

newToBrandDetailPageViews

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who either clicked or viewed an ad

newToBrandDetailPageViewsClicks

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who clicked an ad

newToBrandECPDetailPageView

bigdecimal

Effective cost per new-to-brand detail page view, calculated by cost divided by new-to-brand detail page view

newToBrandPurchases

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click or view. Not available for book vendors

newToBrandPurchasesClicks

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click. Not available for book vendors

newToBrandPurchasesPercentage

bigdecimal

The percentage of total orders that are new-to-brand orders within 14 days of an ad click. Not available for book vendors.

newToBrandPurchasesRate

bigdecimal

The percentage of total orders that are new-to-brand orders. Not available for book vendors

newToBrandSales

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandSalesClicks

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandSalesPercentage

bigdecimal

Percentage of total sales made up of new-to-brand purchases within 14 days of an ad click. Not available for book vendors. Same as newToBrandSalesPercentage14d

newToBrandUnitsSold

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandUnitsSoldClicks

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandUnitsSoldPercentage

bigdecimal

Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors. Same as newToBrandUnitsSoldPercentage14d

placementClassification

string

The page location where an ad appeared

purchases

integer

Number of attributed conversion events occurring within 14 days of an ad click or view

purchasesClicks

integer

Number of attributed conversion events occurring within 14 days of an ad click

purchasesPromoted

integer

Number of attributed conversion events occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as purchasesSameSku14d

qualifiedBorrows

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

qualifiedBorrowsFromClicks

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrows

integer

Estimated royalty payment attributed to Kindle Unlimited users downloading the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrowsFromClicks

integer

Estimated royalty payment attributed to Kindle Unlimited users who clicked on the ad, downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

sales

bigdecimal

Total value of sales occurring within 14 days of an ad click or view.

salesClicks

bigdecimal

Total value of sales occurring within 14 days of an ad click.

salesPromoted

bigdecimal

Total value of sales occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as attributedSales14dSameSKU

unitsSold

integer

Number of attributed units sold within 14 days of an ad click or view

unitsSoldClicks

integer

Number of attributed units sold within 14 days of an ad click

video5SecondViewRate

bigdecimal

The percentage of impressions where the customer watched the complete video or 5 seconds of the video (whichever is shorter). Sponsored Brands video-only metric

video5SecondViews

integer

The number of impressions where the customer watched the complete video or 5 seconds (whichever is shorter). Sponsored Brands video-only metric

videoCompleteViews

integer

The number of impressions where the video was viewed to 100%

videoFirstQuartileViews

integer

The number of impressions where the video was viewed to 25%

videoMidpointViews

integer

The number of impressions where the video was viewed to 50%

videoThirdQuartileViews

integer

The number of impressions where the video was viewed to 75%

videoUnmutes

integer

The number of impressions where a customer unmuted the video

viewabilityRate

bigdecimal

View-through rate (vtr). Views divided by impressions

viewableImpressions

integer

Number of impressions that met the Media Ratings Council (MRC) viewability standard. See viewability details at

https://advertising.amazon.com/library/guides/viewability

viewClickThroughRate

bigdecimal

Click-through rate for views (clicks divided by views)

errorMessage

string

Error message if any problem happened

profileId

long

ID of the profile

date

date

Date when the ad activity ocurred in the format YYYY-MM-DD

campaignId

long

The ID associated with a campaign

campaignName

string

The name associated with a campaign

campaignStatus

string

The status of a campaign

addToCart

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad view or click

addToCartClicks

integer

Number of times shoppers added a brand's products to their cart, attributed to an ad click

addToCartRate

bigdecimal

Calculated by divididing addToCart by impressions

addToList

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view or click. Use Total ATL to see all conversions for the brands' products

addToListFromClicks

integer

Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad click

brandedSearches

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click or view

brandedSearchesClicks

integer

The number of searches that included the name of your brand occurring within 14 days of an ad click

campaignBudgetAmount

bigdecimal

Total budget allocated to the campaign

campaignBudgetCurrencyCode

string

The currency code associated with the campaign

campaignBudgetType

string

One of daily or lifetime

clicks

integer

Total number of clicks on an ad

cost

bigdecimal

Total cost of ad clicks

costType

string

Determines how the campaign will bid and charge. One of vCPM (cost per thousand viewable impressions) or CPC (cost per click).

detailPageViews

integer

Number of detail page views occurring within 14 days of an ad click or view

detailPageViewsClicks

integer

Number of detail page views occurring within 14 days of an ad click

eCPAddToCart

bigdecimal

Effect cost per add to cart, calculated by cost divided by add-to-cart

impressions

integer

Total number of ad impressions

newToBrandDetailPageViewRate

bigdecimal

Calculated by dividing newToBrandDetailPageViews / impressions

newToBrandDetailPageViews

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who either clicked or viewed an ad

newToBrandDetailPageViewsClicks

integer

The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who clicked an ad

newToBrandECPDetailPageView

bigdecimal

Effective cost per new-to-brand detail page view, calculated by cost divided by new-to-brand detail page view

newToBrandPurchases

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click or view. Not available for book vendors

newToBrandPurchasesClicks

integer

The number of first-time orders for brand products over a one-year lookback window resulting from an ad click. Not available for book vendors

newToBrandPurchasesPercentage

bigdecimal

The percentage of total orders that are new-to-brand orders within 14 days of an ad click. Not available for book vendors.

newToBrandPurchasesRate

bigdecimal

The percentage of total orders that are new-to-brand orders. Not available for book vendors

newToBrandSales

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandSalesClicks

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandSalesPercentage

bigdecimal

Percentage of total sales made up of new-to-brand purchases within 14 days of an ad click. Not available for book vendors. Same as newToBrandSalesPercentage14d

newToBrandUnitsSold

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors

newToBrandUnitsSoldClicks

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandUnitsSoldPercentage

bigdecimal

Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors. Same as newToBrandUnitsSoldPercentage14d

purchases

integer

Number of attributed conversion events occurring within 14 days of an ad click or view

purchasesClicks

integer

Number of attributed conversion events occurring within 14 days of an ad click

purchasesPromoted

integer

Number of attributed conversion events occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as purchasesSameSku14d

qualifiedBorrows

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

qualifiedBorrowsFromClicks

integer

Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrows

integer

Estimated royalty payment attributed to Kindle Unlimited users downloading the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

royaltyQualifiedBorrowsFromClicks

integer

Estimated royalty payment attributed to Kindle Unlimited users who clicked on the ad, downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only

sales

bigdecimal

Total value of sales occurring within 14 days of an ad click or view.

salesClicks

bigdecimal

Total value of sales occurring within 14 days of an ad click.

salesPromoted

bigdecimal

Total value of sales occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as attributedSales14dSameSKU

topOfSearchImpressionShare

bigdecimal

The percentage of top-of-search impressions earned out of all the top-of-search impressions that were eligible for a given date range. Various factors determine the eligibility for an impression including campaign status and targeting status

unitsSold

integer

Number of attributed units sold within 14 days of an ad click or view

unitsSoldClicks

integer

Number of attributed units sold within 14 days of an ad click

video5SecondViewRate

bigdecimal

The percentage of impressions where the customer watched the complete video or 5 seconds of the video (whichever is shorter). Sponsored Brands video-only metric

video5SecondViews

integer

The number of impressions where the customer watched the complete video or 5 seconds (whichever is shorter). Sponsored Brands video-only metric

videoCompleteViews

integer

The number of impressions where the video was viewed to 100%

videoFirstQuartileViews

integer

The number of impressions where the video was viewed to 25%

videoMidpointViews

integer

The number of impressions where the video was viewed to 50%

videoThirdQuartileViews

integer

The number of impressions where the video was viewed to 75%

videoUnmutes

integer

The number of impressions where a customer unmuted the video

viewabilityRate

bigdecimal

View-through rate (vtr). Views divided by impressions

viewableImpressions

integer

Number of impressions that met the Media Ratings Council (MRC) viewability standard. See viewability details at

https://advertising.amazon.com/library/guides/viewability

viewClickThroughRate

bigdecimal

Click-through rate for views (clicks divided by views)

errorMessage

string

Error message if any problem happened

profileId

long

ID of the profile

date

date

Date when the ad activity ocurred in the format YYYY-MM-DD

campaignName

string

The name associated with a campaign

campaignStatus

string

The status of a campaign

clicks

integer

Total number of clicks on an ad

grossClickThroughs

integer

The total number of times the ad was clicked. This includes valid, potentially fraudulent, non-human, and other illegitimate clicks

grossImpressions

integer

The total number of times the ad was displayed. This includes valid and invalid impressions such as potentially fraudulent, non-human, and other illegitimate impressions

impressions

integer

Total number of ad impressions

invalidClickThroughRate

bigdecimal

The percentage of gross click-throughs that were removed by the traffic quality filter. (Invalid click-throughs rate = invalid click-throughs / gross click-throughs)

invalidClickThroughs

integer

Clicks that were removed by the traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic

invalidImpressionRate

bigdecimal

The percentage of gross impressions that were removed by the traffic quality filter. (Invalid impression rate = invalid impressions / gross impressions)

invalidImpressions

integer

The number of impressions removed by a traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic

errorMessage

string

Error message if any problem happened

profileId

long

Profile ID

date

date

Date when the ad activity occurred in the format YYYY-MM-DD

adGroupName

string

The name of the ad group as entered by the advertiser

attributionType

string

Describes whether a purchase is attributed to a promoted product or brand-halo effect

budgetCurrency

string

The currency code

campaignBudgetCurrencyCode

string

The currency code associated with the campaign

campaignName

string

The name associated with a campaign

newToBrandOrders14d

integer

The number of orders

newToBrandOrdersPercentage14d

bigdecimal

The percentage of orders

newToBrandPurchases14d

integer

The number of first-time orders for brand products over a one-year lookback window. Not available for book vendors

newToBrandPurchasesPercentage14d

bigdecimal

The percentage of total orders that are new-to-brand orders. Not available for book vendors

newToBrandSales14d

bigdecimal

Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandSalesPercentage14d

bigdecimal

Percentage of total sales made up of new-to-brand purchases. Not available for book vendors

newToBrandUnitsSold14d

integer

Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors

newToBrandUnitsSoldPercentage14d

bigdecimal

Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors

orders14d

integer

Orders within the last 14 days

productCategory

string

The category the product is associated with on Amazon

productName

string

The name of the product

purchasedAsin

string

The ASIN of the product that was purchased

sales14d

bigdecimal

Total value of sales occurring within 14 days of an ad click

unitsSold14d

integer

Number of attributed units sold within 14 days of click on an ad. Vendor-only field. Same as unitsSoldClicks14d