Amazon Ads Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » Amazon Ads Connector » EndPoints > Get Beta Report

EndPoint Get Beta Report

Name

get_beta_report

Description

Generates and downloads an Amazon Ads report. [API Help]

Parameters

Parameter Label Required Options Description
ReportName Report Name YES
ReportType Report Type YES
Option Value
Campaigns spCampaigns
Targeting spTargeting
Search Term spSearchTerm
Advertised Product spAdvertisedProduct
Purchased Product spPurchasedProduct
TimeUnit Time Unit NO
Option Value
Summary SUMMARY
Daily DAILY
GroupByCampaignReportType Group By NO
Option Value
Campaign campaign
Ad Group adGroup
Campaign Placement campaignPlacement
GroupByTargetingReportType Group By NO
Option Value
Targeting targeting
GroupBySearchTermReportType Group By NO
Option Value
Search Term searchTerm
GroupByAdvertisedProductReportType Group By NO
Option Value
Advertiser advertiser
GroupByPurchasedProductReportType Group By NO
Option Value
ASIN asin
Purchased ASIN purchasedAsin
StartDatePurchasedProductReportTypeGroupByAsin Report Start Date (yyyy-MM-dd) Maximum date range: 31 days YES
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
The start date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
EndDatePurchasedProductReportTypeGroupByAsin Report End Date (yyyy-MM-dd) Maximum date range: 31 days YES
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
The end date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
StartDatePurchasedProductReportTypeGroupByPurchasedAsin Report Start Date (yyyy-MM-dd) Maximum date range: 731 days YES
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
The start date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
EndDatePurchasedProductReportTypeGroupByPurchasedAsin Report End Date (yyyy-MM-dd) Maximum date range: 731 days YES
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
The end date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
GroupByCampaignMetrics Metrics NO
Option Value
impressions impressions
clicks clicks
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
date date
startDate startDate
endDate endDate
campaignBiddingStrategy campaignBiddingStrategy
costPerClick costPerClick
clickThroughRate clickThroughRate
spend spend
campaignName campaignName
campaignId campaignId
campaignStatus campaignStatus
campaignBudgetAmount campaignBudgetAmount
campaignBudgetType campaignBudgetType
campaignRuleBasedBudgetAmount campaignRuleBasedBudgetAmount
campaignApplicableBudgetRuleId campaignApplicableBudgetRuleId
campaignApplicableBudgetRuleName campaignApplicableBudgetRuleName
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
topOfSearchImpressionShare topOfSearchImpressionShare
GroupByAdGroupMetrics Metrics NO
Option Value
impressions impressions
clicks clicks
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
date date
startDate startDate
endDate endDate
campaignBiddingStrategy campaignBiddingStrategy
costPerClick costPerClick
clickThroughRate clickThroughRate
spend spend
adGroupName adGroupName
adGroupId adGroupId
adStatus adStatus
GroupByCampaignPlacementMetrics Metrics NO
Option Value
impressions impressions
clicks clicks
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
date date
startDate startDate
endDate endDate
campaignBiddingStrategy campaignBiddingStrategy
costPerClick costPerClick
clickThroughRate clickThroughRate
spend spend
placementClassification placementClassification
GroupByTargetingMetrics Metrics NO
Option Value
impressions impressions
clicks clicks
costPerClick costPerClick
clickThroughRate clickThroughRate
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
salesOtherSku7d salesOtherSku7d
unitsSoldOtherSku7d unitsSoldOtherSku7d
acosClicks7d acosClicks7d
acosClicks14d acosClicks14d
roasClicks7d roasClicks7d
roasClicks14d roasClicks14d
keywordId keywordId
keyword keyword
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
date date
startDate startDate
endDate endDate
portfolioId portfolioId
campaignName campaignName
campaignId campaignId
campaignBudgetType campaignBudgetType
campaignBudgetAmount campaignBudgetAmount
campaignStatus campaignStatus
keywordBid keywordBid
adGroupName adGroupName
adGroupId adGroupId
keywordType keywordType
matchType matchType
targeting targeting
topOfSearchImpressionShare topOfSearchImpressionShare
adKeywordStatus adKeywordStatus
GroupBySearchTermMetrics Metrics NO
Option Value
impressions impressions
clicks clicks
costPerClick costPerClick
clickThroughRate clickThroughRate
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
salesOtherSku7d salesOtherSku7d
unitsSoldOtherSku7d unitsSoldOtherSku7d
acosClicks7d acosClicks7d
acosClicks14d acosClicks14d
roasClicks7d roasClicks7d
roasClicks14d roasClicks14d
keywordId keywordId
keyword keyword
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
date date
startDate startDate
endDate endDate
portfolioId portfolioId
searchTerm searchTerm
campaignName campaignName
campaignId campaignId
campaignBudgetType campaignBudgetType
campaignBudgetAmount campaignBudgetAmount
campaignStatus campaignStatus
keywordBid keywordBid
adGroupName adGroupName
adGroupId adGroupId
keywordType keywordType
matchType matchType
targeting targeting
adKeywordStatus adKeywordStatus
GroupByAdvertiserMetrics Metrics NO
Option Value
date date
startDate startDate
endDate endDate
campaignName campaignName
campaignId campaignId
adGroupName adGroupName
adGroupId adGroupId
adId adId
portfolioId portfolioId
impressions impressions
clicks clicks
costPerClick costPerClick
clickThroughRate clickThroughRate
cost cost
spend spend
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
campaignBudgetAmount campaignBudgetAmount
campaignBudgetType campaignBudgetType
campaignStatus campaignStatus
advertisedAsin advertisedAsin
advertisedSku advertisedSku
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
salesOtherSku7d salesOtherSku7d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
unitsSoldOtherSku7d unitsSoldOtherSku7d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
acosClicks7d acosClicks7d
acosClicks14d acosClicks14d
roasClicks7d roasClicks7d
roasClicks14d roasClicks14d

Output Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.