Reference

Endpoint Get Report

Name

get_report

Description

Downloads an Amazon Ads report. [API reference]

Parameters

Parameter Required Options
Name: RecordType

Label: Record Type

 YES
Option Value
campaigns campaigns
adGroups adGroups
keywords keywords
productAds productAds
asins asins
Name: ReportDate

Label: Report Date (yyyyMMdd)

The date for which to retrieve the report in YYYYMMDD 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 3days from month start) 		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
Name: Metrics

Label: Metrics

 YES
Option Value
adGroupId adGroupId
adGroupName adGroupName
attributedConversions14d attributedConversions14d
attributedConversions14dSameSKU attributedConversions14dSameSKU
attributedConversions1d attributedConversions1d
attributedConversions1dSameSKU attributedConversions1dSameSKU
attributedConversions30d attributedConversions30d
attributedConversions30dSameSKU attributedConversions30dSameSKU
attributedConversions7d attributedConversions7d
attributedConversions7dSameSKU attributedConversions7dSameSKU
attributedKindleEditionNormalizedPagesRead14d attributedKindleEditionNormalizedPagesRead14d
attributedKindleEditionNormalizedPagesRoyalties14d attributedKindleEditionNormalizedPagesRoyalties14d
attributedSales14d attributedSales14d
attributedSales14dSameSKU attributedSales14dSameSKU
attributedSales1d attributedSales1d
attributedSales1dSameSKU attributedSales1dSameSKU
attributedSales30d attributedSales30d
attributedSales30dSameSKU attributedSales30dSameSKU
attributedSales7d attributedSales7d
attributedSales7dSameSKU attributedSales7dSameSKU
attributedUnitsOrdered14d attributedUnitsOrdered14d
attributedUnitsOrdered14dSameSKU attributedUnitsOrdered14dSameSKU
attributedUnitsOrdered1d attributedUnitsOrdered1d
attributedUnitsOrdered1dSameSKU attributedUnitsOrdered1dSameSKU
attributedUnitsOrdered30d attributedUnitsOrdered30d
attributedUnitsOrdered30dSameSKU attributedUnitsOrdered30dSameSKU
attributedUnitsOrdered7d attributedUnitsOrdered7d
attributedUnitsOrdered7dSameSKU attributedUnitsOrdered7dSameSKU
campaignBudget campaignBudget
campaignBudgetType campaignBudgetType
campaignId campaignId
campaignName campaignName
campaignStatus campaignStatus
clicks clicks
cost cost
currency currency
impressions impressions
keywordBid keywordBid
keywordId keywordId
keywordStatus keywordStatus
keywordText keywordText
matchType matchType
query query
Name: StateFilter

Label: State Filter
Option Value
enabled enabled
paused paused
archived archived
Name: CampaignType

Label: Campaign Type
Option Value
sponsoredProducts sponsoredProducts
headlineSearch headlineSearch
Name: Segment

Label: Segment
Option Value
query query
placement placement

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing Amazon Ads Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Amazon Ads Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Amazon Ads
Read and write Amazon Ads data effortlessly. Integrate, manage, and automate campaigns, ad groups, and performance metrics — almost no coding required.
Amazon Ads
Get Report
Required Parameters
Record Type Fill-in the parameter...
Report Date (yyyyMMdd) Fill-in the parameter...
Metrics Fill-in the parameter...
Optional Parameters
State Filter
Campaign Type
Segment
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Amazon Ads
Read and write Amazon Ads data effortlessly. Integrate, manage, and automate campaigns, ad groups, and performance metrics — almost no coding required.
Amazon Ads
Get Report
Required Parameters
Record Type Fill-in the parameter...
Report Date (yyyyMMdd) Fill-in the parameter...
Metrics Fill-in the parameter...
Optional Parameters
State Filter
Campaign Type
Segment
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Read Sponsored Products report (legacy API) 

SELECT * FROM get_report
WITH(
  RecordType='keywords',
  ReportDate='<<today-1d,FUN_TO_DATE>>',
  Metrics='impressions,clicks,cost'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read Sponsored Products report (legacy API) 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_report
WITH(
  RecordType=''keywords'',
  ReportDate=''<<today-1d,FUN_TO_DATE>>'',
  Metrics=''impressions,clicks,cost''
)';

EXEC (@MyQuery) AT [LS_TO_AMAZON_ADS_IN_GATEWAY];