{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ecommercedataapi-com/json-schema/ecommercedataapi-com-amazon-keywords-aba-weekly-request-schema.json",
  "title": "AmazonKeywordsAbaWeeklyRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ecommercedataapi-com-openapi.json#/components/schemas/AmazonKeywordsAbaWeeklyRequest",
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "description": "Week to query, given as the Saturday that ends it in yyyyMMdd. Omit it to get the latest week."
    },
    "departments": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Departments."
      },
      "description": "Departments."
    },
    "excludeKeywords": {
      "type": "string",
      "description": "Exclude keywords."
    },
    "includeKeywords": {
      "type": "string",
      "description": "Include keywords."
    },
    "marketplace": {
      "type": "string",
      "enum": [
        "US",
        "UK",
        "DE",
        "FR",
        "IT",
        "ES",
        "MX",
        "CA",
        "AU",
        "JP",
        "IN",
        "AE",
        "BR"
      ],
      "description": "Amazon marketplace code. Supported values are listed in the schema."
    },
    "maxClicks": {
      "type": "integer",
      "format": "int32",
      "description": "Max clicks. Maximum value."
    },
    "maxConversionRate": {
      "type": "number",
      "format": "double",
      "description": "Max conversion rate. Maximum value. Percentage or ratio value as documented."
    },
    "maxImpressions": {
      "type": "integer",
      "format": "int32",
      "description": "Max impressions. Maximum value."
    },
    "maxMonopolyClickRate": {
      "type": "number",
      "format": "double",
      "description": "Max monopoly click rate. Maximum value."
    },
    "maxRankGrowthRate": {
      "type": "number",
      "format": "double",
      "description": "Max rank growth rate. Maximum value. Percentage or ratio value as documented."
    },
    "maxSPR": {
      "type": "integer",
      "format": "int32",
      "description": "Max SPR. Maximum value."
    },
    "maxSearchRank": {
      "type": "integer",
      "format": "int32",
      "description": "Max search rank. Maximum value."
    },
    "maxSearches": {
      "type": "integer",
      "format": "int32",
      "description": "Max searches. Maximum value."
    },
    "maxTitleDensity": {
      "type": "integer",
      "format": "int32",
      "description": "Max title density. Maximum value."
    },
    "maxWordCount": {
      "type": "integer",
      "format": "int32",
      "description": "Max word count. Maximum value."
    },
    "minClicks": {
      "type": "integer",
      "format": "int32",
      "description": "Min clicks. Minimum value."
    },
    "minConversionRate": {
      "type": "number",
      "format": "double",
      "description": "Min conversion rate. Minimum value. Percentage or ratio value as documented."
    },
    "minImpressions": {
      "type": "integer",
      "format": "int32",
      "description": "Min impressions. Minimum value."
    },
    "minMonopolyClickRate": {
      "type": "number",
      "format": "double",
      "description": "Min monopoly click rate. Minimum value."
    },
    "minRankGrowthRate": {
      "type": "number",
      "format": "double",
      "description": "Min rank growth rate. Minimum value. Percentage or ratio value as documented."
    },
    "minSPR": {
      "type": "integer",
      "format": "int32",
      "description": "Min SPR. Minimum value."
    },
    "minSearchRank": {
      "type": "integer",
      "format": "int32",
      "description": "Min search rank. Minimum value."
    },
    "minSearches": {
      "type": "integer",
      "format": "int32",
      "description": "Min searches. Minimum value."
    },
    "minTitleDensity": {
      "type": "integer",
      "format": "int32",
      "description": "Min title density. Minimum value."
    },
    "minWordCount": {
      "type": "integer",
      "format": "int32",
      "description": "Min word count. Minimum value."
    },
    "order": {
      "type": "object",
      "properties": {
        "desc": {
          "type": "boolean",
          "description": "Use true for descending order or false for ascending order."
        },
        "field": {
          "type": "string",
          "description": "Field used to sort the results. Available values (Table 2.4): searchfrequencyrank, cprExact, titleDensityExact, searches"
        }
      },
      "additionalProperties": false,
      "description": "Sort definition."
    },
    "page": {
      "type": "integer",
      "format": "int32",
      "minimum": 1,
      "description": "Page number starting at 1."
    },
    "rankGrowthRate": {
      "type": "number",
      "format": "double",
      "description": "Rank growth rate. Percentage or ratio value as documented."
    },
    "rankGrowthValue": {
      "type": "integer",
      "format": "int32",
      "description": "Rank growth value."
    },
    "returnFields": {
      "type": "string",
      "description": "Optional comma-separated response fields. Omit it to receive the standard payload."
    },
    "searchModel": {
      "type": "integer",
      "format": "int32",
      "description": "Search model."
    },
    "size": {
      "type": "integer",
      "format": "int32",
      "minimum": 1,
      "description": "Number of results per page."
    }
  },
  "required": [
    "marketplace"
  ],
  "additionalProperties": false
}