Amazon Keywords

Amazon ABA Weekly Research

Research weekly Amazon Brand Analytics keyword metrics.

post/v1/amazon/aba/research/weekly

Request

  • Base URL: https://ecommercedataapi.com
  • URL: https://ecommercedataapi.com/v1/amazon/aba/research/weekly
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

datestring

Week to query, given as the Saturday that ends it in yyyyMMdd. Omit it to get the latest week.

departmentsstring[]

Departments.

excludeKeywordsstring

Exclude keywords.

includeKeywordsstring

Include keywords.

marketplace'US' | 'UK' | 'DE' | 'FR' | 'IT' | 'ES' | 'MX' | 'CA' | 'AU' | 'JP' | 'IN' | 'AE' | 'BR' required

Amazon marketplace code. Supported values are listed in the schema.

maxClicksinteger

Max clicks. Maximum value.

maxConversionRatenumber double

Max conversion rate. Maximum value. Percentage or ratio value as documented.

maxImpressionsinteger

Max impressions. Maximum value.

maxMonopolyClickRatenumber double

Max monopoly click rate. Maximum value.

maxRankGrowthRatenumber double

Max rank growth rate. Maximum value. Percentage or ratio value as documented.

maxSPRinteger

Max SPR. Maximum value.

maxSearchRankinteger

Max search rank. Maximum value.

maxSearchesinteger

Max searches. Maximum value.

maxTitleDensityinteger

Max title density. Maximum value.

maxWordCountinteger

Max word count. Maximum value.

minClicksinteger

Min clicks. Minimum value.

minConversionRatenumber double

Min conversion rate. Minimum value. Percentage or ratio value as documented.

minImpressionsinteger

Min impressions. Minimum value.

minMonopolyClickRatenumber double

Min monopoly click rate. Minimum value.

minRankGrowthRatenumber double

Min rank growth rate. Minimum value. Percentage or ratio value as documented.

minSPRinteger

Min SPR. Minimum value.

minSearchRankinteger

Min search rank. Minimum value.

minSearchesinteger

Min searches. Minimum value.

minTitleDensityinteger

Min title density. Minimum value.

minWordCountinteger

Min word count. Minimum value.

pageinteger

Page number starting at 1.

rankGrowthRatenumber double

Rank growth rate. Percentage or ratio value as documented.

rankGrowthValueinteger

Rank growth value.

returnFieldsstring

Optional comma-separated response fields. Omit it to receive the standard payload.

searchModelinteger

Search model.

sizeinteger

Number of results per page.

Example request

{
  "date": "20230610",
  "departments": [
    "automotive",
    "baby-products"
  ],
  "excludeKeywords": "portable",
  "includeKeywords": "Include keywords",
  "marketplace": "US",
  "maxClicks": 10000,
  "maxConversionRate": 1,
  "maxImpressions": 20000,
  "maxMonopolyClickRate": 1,
  "maxRankGrowthRate": 1,
  "maxSPR": 1,
  "maxSearchRank": 1,
  "maxSearches": 1,
  "maxTitleDensity": 1,
  "maxWordCount": 1,
  "minClicks": 1,
  "minConversionRate": 1,
  "minImpressions": 10000,
  "minMonopolyClickRate": 1,
  "minRankGrowthRate": 1,
  "minSPR": 1,
  "minSearchRank": 1,
  "minSearches": 1,
  "minTitleDensity": 1,
  "minWordCount": 1,
  "order": {},
  "page": 1,
  "rankGrowthRate": 1,
  "rankGrowthValue": 1,
  "returnFields": "marketplace,date,keyword",
  "searchModel": 1,
  "size": 40
}

Response

Amazon ABA Weekly Research response.

request_idstring uuid required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.