---
title: "Amazon ABA Weekly Research"
method: POST
path: "/v1/amazon/aba/research/weekly"
tags: ["Amazon Keywords"]
---

# Amazon ABA Weekly Research

`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

Research weekly Amazon Brand Analytics keyword metrics.

## Request body

- AmazonKeywordsAbaWeeklyRequest
  - `date` string: Week to query, given as the Saturday that ends it in yyyyMMdd. Omit it to get the latest week.
  - `departments` string[]: Departments.
  - `excludeKeywords` string: Exclude keywords.
  - `includeKeywords` string: 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.
  - `maxClicks` integer: Max clicks. Maximum value.
  - `maxConversionRate` number, double: Max conversion rate. Maximum value. Percentage or ratio value as documented.
  - `maxImpressions` integer: Max impressions. Maximum value.
  - `maxMonopolyClickRate` number, double: Max monopoly click rate. Maximum value.
  - `maxRankGrowthRate` number, double: Max rank growth rate. Maximum value. Percentage or ratio value as documented.
  - `maxSPR` integer: Max SPR. Maximum value.
  - `maxSearchRank` integer: Max search rank. Maximum value.
  - `maxSearches` integer: Max searches. Maximum value.
  - `maxTitleDensity` integer: Max title density. Maximum value.
  - `maxWordCount` integer: Max word count. Maximum value.
  - `minClicks` integer: Min clicks. Minimum value.
  - `minConversionRate` number, double: Min conversion rate. Minimum value. Percentage or ratio value as documented.
  - `minImpressions` integer: Min impressions. Minimum value.
  - `minMonopolyClickRate` number, double: Min monopoly click rate. Minimum value.
  - `minRankGrowthRate` number, double: Min rank growth rate. Minimum value. Percentage or ratio value as documented.
  - `minSPR` integer: Min SPR. Minimum value.
  - `minSearchRank` integer: Min search rank. Minimum value.
  - `minSearches` integer: Min searches. Minimum value.
  - `minTitleDensity` integer: Min title density. Minimum value.
  - `minWordCount` integer: Min word count. Minimum value.
  - `order` object: Sort definition.
    - `desc` boolean: Use true for descending order or false for ascending order.
    - `field` string: Field used to sort the results. Available values (Table 2.4): searchfrequencyrank, cprExact, titleDensityExact, searches
  - `page` integer: Page number starting at 1.
  - `rankGrowthRate` number, double: Rank growth rate. Percentage or ratio value as documented.
  - `rankGrowthValue` integer: Rank growth value.
  - `returnFields` string: Optional comma-separated response fields. Omit it to receive the standard payload.
  - `searchModel` integer: Search model.
  - `size` integer: Number of results per page.

## Response `200`

Amazon ABA Weekly Research response.

- GatewaySuccess
  - `request_id` string, uuid, required
  - `data` unknown, required

## Other responses

- `400`: The request body or parameters are invalid.
- `401`: Authentication failed.
- `402`: The account does not have enough Credits for this request.
- `403`: The subscription does not include this endpoint.
- `404`: The endpoint does not exist.
- `413`: The request body is too large.
- `429`: The request limit was exceeded.
- `500`: An internal error occurred.
- `502`: The data service returned an invalid response.
- `503`: The data service is temporarily unavailable.
- `504`: The data service timed out.

---

[API](https://skmtc.dev/ecommercedataapi/apis/ecommerce-data-api.md) · [All operations](https://skmtc.dev/ecommercedataapi/apis/ecommerce-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ecommercedataapi/apis/ecommerce-data-api/revisions/bdae32c46b9e?raw)