Variable sellingPartnerSearchQueryPerformanceReportConst

Type declaration

• Readonlydefinitions: {
      CurrencyAmount: {
          description: "Represents an amount of money in a specific currency.";
          properties: {
              amount: {
                  description: "The monetary amount.";
                  examples: readonly [19.99];
                  type: "number";
              };
              currencyCode: {
                  description: "The 3-letter currency code, in ISO 4217 format.";
                  examples: readonly ["USD"];
                  pattern: "[A-Z]{3}";
                  type: "string";
              };
          };
          required: readonly ["amount", "currencyCode"];
          type: "object";
      };
      SearchQueryData: {
          description: "The search query data.";
          properties: {
              searchQuery: {
                  description: "A buying customer’s search query that is relevant to your branded catalog.";
                  examples: readonly ["wireless headphones"];
                  type: "string";
              };
              searchQueryScore: {
                  description: "The rank for a search query in comparison to other queries for the ASIN. The ranking mechanism measures overall performance (the highest rank is 1).";
                  examples: readonly [5];
                  type: "integer";
              };
              searchQueryVolume: {
                  description: "The number of times customers search for a query at a select time period.";
                  examples: readonly [15000];
                  type: "integer";
              };
          };
          required: readonly [
              "searchQuery",
              "searchQueryScore",
              "searchQueryVolume",
          ];
          type: "object";
      };
      SearchQueryPerformanceCartAddData: {
          description: "The search query performance cart add data.";
          properties: {
              asinCartAddCount: {
                  description: "For a search query, the number of cart-adds for the ASIN that originates from the search results page.";
                  examples: readonly [10];
                  type: "integer";
              };
              asinCartAddShare: {
                  description: "The fraction of cart-adds for the ASIN in comparison to the total cart-add count for the query.";
                  examples: readonly [0.05];
                  type: "number";
              };
              asinMedianCartAddPrice: { $ref: "#/definitions/CurrencyAmount" };
              totalCartAddCount: {
                  description: "For a search query, the number of cart-adds that originate from the search result page across all ASINs.";
                  examples: readonly [200];
                  type: "integer";
              };
              totalCartAddRate: {
                  description: "For a search query, the number of cart-adds across all ASINs divided by the search query volume.";
                  examples: readonly [0.02];
                  type: "number";
              };
              totalMedianCartAddPrice: { $ref: "#/definitions/CurrencyAmount" };
              totalOneDayShippingCartAddCount: {
                  description: "The number of times customers add any ASIN with the one-day delivery message to a cart from the search results page for the specific query.";
                  examples: readonly [60];
                  type: "integer";
              };
              totalSameDayShippingCartAddCount: {
                  description: "The number of times customers add any ASIN with the same-day delivery message to a cart from the search results page for the specific query.";
                  examples: readonly [40];
                  type: "integer";
              };
              totalTwoDayShippingCartAddCount: {
                  description: "The number of times customers add any ASIN with the two-day delivery message to a cart from the search results page for the specific query.";
                  examples: readonly [100];
                  type: "integer";
              };
          };
          required: readonly [
              "totalCartAddCount",
              "totalCartAddRate",
              "asinCartAddCount",
              "asinCartAddShare",
              "totalMedianCartAddPrice",
              "asinMedianCartAddPrice",
              "totalSameDayShippingCartAddCount",
              "totalOneDayShippingCartAddCount",
              "totalTwoDayShippingCartAddCount",
          ];
          type: "object";
      };
      SearchQueryPerformanceClickData: {
          description: "The search query performance click data.";
          properties: {
              asinClickCount: {
                  description: "For a search query, the number of clicks for the current ASIN.";
                  examples: readonly [50];
                  type: "integer";
              };
              asinClickShare: {
                  description: "The fraction of clicks for the current ASIN in comparison to the total click count for the query.";
                  examples: readonly [0.05];
                  type: "number";
              };
              asinMedianClickPrice: { $ref: "#/definitions/CurrencyAmount" };
              totalClickCount: {
                  description: "For a search query, the number of ASIN clicks that originate from the search results page for any ASIN.";
                  examples: readonly [1000];
                  type: "integer";
              };
              totalClickRate: {
                  description: "For a search query, the number of clicks divided by the search query volume.";
                  examples: readonly [0.1];
                  type: "number";
              };
              totalMedianClickPrice: { $ref: "#/definitions/CurrencyAmount" };
              totalOneDayShippingClickCount: {
                  description: "The number of times customers click on any ASIN with the one-day delivery message from the search results page for the specific query.";
                  examples: readonly [300];
                  type: "integer";
              };
              totalSameDayShippingClickCount: {
                  description: "The number of times customers click on any ASIN with the same-day delivery message from the search results page for the specific query.";
                  examples: readonly [200];
                  type: "integer";
              };
              totalTwoDayShippingClickCount: {
                  description: "The number of times customers click on any ASIN with the two-day delivery message from the search results page for the specific query.";
                  examples: readonly [500];
                  type: "integer";
              };
          };
          required: readonly [
              "totalClickCount",
              "totalClickRate",
              "asinClickCount",
              "asinClickShare",
              "totalMedianClickPrice",
              "asinMedianClickPrice",
              "totalSameDayShippingClickCount",
              "totalOneDayShippingClickCount",
              "totalTwoDayShippingClickCount",
          ];
          type: "object";
      };
      SearchQueryPerformanceData: {
          description: "Contains search query performance data at the ASIN level.";
          examples: readonly [
              {
                  asin: "B123456789";
                  cartAddData: {
                      asinCartAddCount: 10;
                      asinCartAddShare: 0.05;
                      asinMedianCartAddPrice: { amount: 19.99; currencyCode: "USD" };
                      totalCartAddCount: 200;
                      totalCartAddRate: 0.02;
                      totalMedianCartAddPrice: { amount: 19.99; currencyCode: "USD" };
                      totalOneDayShippingCartAddCount: 60;
                      totalSameDayShippingCartAddCount: 40;
                      totalTwoDayShippingCartAddCount: 100;
                  };
                  clickData: {
                      asinClickCount: 50;
                      asinClickShare: 0.05;
                      asinMedianClickPrice: { amount: 19.99; currencyCode: "USD" };
                      totalClickCount: 1000;
                      totalClickRate: 0.1;
                      totalMedianClickPrice: { amount: 19.99; currencyCode: "USD" };
                      totalOneDayShippingClickCount: 300;
                      totalSameDayShippingClickCount: 200;
                      totalTwoDayShippingClickCount: 500;
                  };
                  endDate: "2025-01-11";
                  impressionData: {
                      asinImpressionCount: 765;
                      asinImpressionShare: 0.0765;
                      totalQueryImpressionCount: 10000;
                  };
                  purchaseData: {
                      asinMedianPurchasePrice: { amount: 19.99; currencyCode: "USD" };
                      asinPurchaseCount: 5;
                      asinPurchaseShare: 0.05;
                      totalMedianPurchasePrice: { amount: 19.99; currencyCode: "USD" };
                      totalOneDayShippingPurchaseCount: 30;
                      totalPurchaseCount: 100;
                      totalPurchaseRate: 0.01;
                      totalSameDayShippingPurchaseCount: 20;
                      totalTwoDayShippingPurchaseCount: 50;
                  };
                  searchQueryData: {
                      searchQuery: "wireless headphones";
                      searchQueryScore: 5;
                      searchQueryVolume: 15000;
                  };
                  startDate: "2025-01-05";
              },
          ];
          properties: {
              asin: {
                  description: "The Amazon Standard Identification Number.";
                  examples: readonly ["B123456789"];
                  type: "string";
              };
              cartAddData: { $ref: "#/definitions/SearchQueryPerformanceCartAddData" };
              clickData: { $ref: "#/definitions/SearchQueryPerformanceClickData" };
              endDate: {
                  description: "The end date of the data for the ASIN that you specify.";
                  examples: readonly ["2025-01-11"];
                  format: "date";
                  type: "string";
              };
              impressionData: {
                  $ref: "#/definitions/SearchQueryPerformanceImpressionData";
              };
              purchaseData: {
                  $ref: "#/definitions/SearchQueryPerformancePurchaseData";
              };
              searchQueryData: { $ref: "#/definitions/SearchQueryData" };
              startDate: {
                  description: "The start date of the data for the ASIN that you specify.";
                  examples: readonly ["2025-01-05"];
                  format: "date";
                  type: "string";
              };
          };
          required: readonly [
              "startDate",
              "endDate",
              "asin",
              "searchQueryData",
              "impressionData",
              "clickData",
              "cartAddData",
              "purchaseData",
          ];
          type: "object";
      };
      SearchQueryPerformanceImpressionData: {
          description: "The search query performance impression data.";
          properties: {
              asinImpressionCount: {
                  description: "The total number of impressions that originate from the search results page for the current ASIN with the current query.";
                  examples: readonly [765];
                  type: "integer";
              };
              asinImpressionShare: {
                  description: "The fraction of impressions for the ASIN in comparison to the total impression count for the query.";
                  examples: readonly [0.0765];
                  type: "number";
              };
              totalQueryImpressionCount: {
                  description: "The total number of impressions that originate from the search results page for all ASINs with the current query.";
                  examples: readonly [10000];
                  type: "integer";
              };
          };
          required: readonly [
              "totalQueryImpressionCount",
              "asinImpressionCount",
              "asinImpressionShare",
          ];
          type: "object";
      };
      SearchQueryPerformancePurchaseData: {
          description: "The search query performance purchase data.";
          properties: {
              asinMedianPurchasePrice: { $ref: "#/definitions/CurrencyAmount" };
              asinPurchaseCount: {
                  description: "For a search query, the number of purchases for the current ASIN.";
                  examples: readonly [5];
                  type: "integer";
              };
              asinPurchaseShare: {
                  description: "The fraction of purchase actions for the ASIN in comparison to the total purchase count for the query.";
                  examples: readonly [0.05];
                  type: "number";
              };
              totalMedianPurchasePrice: { $ref: "#/definitions/CurrencyAmount" };
              totalOneDayShippingPurchaseCount: {
                  description: "The number of times customers purchase any ASIN with a one-day delivery message from the search results page for the specific query.";
                  examples: readonly [30];
                  type: "integer";
              };
              totalPurchaseCount: {
                  description: "For a search query, the number of purchases that originate from the search result for any ASIN.";
                  examples: readonly [100];
                  type: "integer";
              };
              totalPurchaseRate: {
                  description: "For a search query, the number of purchases divided by the search query volume.";
                  examples: readonly [0.01];
                  type: "number";
              };
              totalSameDayShippingPurchaseCount: {
                  description: "The number of times customers purchase any ASIN with the same-day delivery message from the search results page for the specific query.";
                  examples: readonly [20];
                  type: "integer";
              };
              totalTwoDayShippingPurchaseCount: {
                  description: "The number of times customers purchase any ASIN with a two-day delivery message from the search results page for the specific query.";
                  examples: readonly [50];
                  type: "integer";
              };
          };
          required: readonly [
              "totalPurchaseCount",
              "totalPurchaseRate",
              "asinPurchaseCount",
              "asinPurchaseShare",
              "totalMedianPurchasePrice",
              "asinMedianPurchasePrice",
              "totalSameDayShippingPurchaseCount",
              "totalOneDayShippingPurchaseCount",
              "totalTwoDayShippingPurchaseCount",
          ];
          type: "object";
      };
  }

• Readonlydescription: "The Search Query Performance report provides overall query performance, such as impressions, clicks, cart adds, and purchases for a given ASIN and date range that you specify. Data is available at different reporting periods: WEEK, MONTH, and QUARTER. Requests cannot span multiple periods. For example, a request at the WEEK level cannot start on 2025-01-05 and end on 2025-01-18 as this request spans two weeks."

• Readonlyexamples: readonly [
      {
          dataByAsin: readonly [
              {
                  asin: "B123456789";
                  cartAddData: {
                      asinCartAddCount: 10;
                      asinCartAddShare: 0.05;
                      asinMedianCartAddPrice: { amount: 19.99; currencyCode: "USD" };
                      totalCartAddCount: 200;
                      totalCartAddRate: 0.02;
                      totalMedianCartAddPrice: { amount: 19.99; currencyCode: "USD" };
                      totalOneDayShippingCartAddCount: 60;
                      totalSameDayShippingCartAddCount: 40;
                      totalTwoDayShippingCartAddCount: 100;
                  };
                  clickData: {
                      asinClickCount: 50;
                      asinClickShare: 0.05;
                      asinMedianClickPrice: { amount: 19.99; currencyCode: "USD" };
                      totalClickCount: 1000;
                      totalClickRate: 0.1;
                      totalMedianClickPrice: { amount: 19.99; currencyCode: "USD" };
                      totalOneDayShippingClickCount: 300;
                      totalSameDayShippingClickCount: 200;
                      totalTwoDayShippingClickCount: 500;
                  };
                  endDate: "2025-01-11";
                  impressionData: {
                      asinImpressionCount: 765;
                      asinImpressionShare: 0.0765;
                      totalQueryImpressionCount: 10000;
                  };
                  purchaseData: {
                      asinMedianPurchasePrice: { amount: 19.99; currencyCode: "USD" };
                      asinPurchaseCount: 5;
                      asinPurchaseShare: 0.05;
                      totalMedianPurchasePrice: { amount: 19.99; currencyCode: "USD" };
                      totalOneDayShippingPurchaseCount: 30;
                      totalPurchaseCount: 100;
                      totalPurchaseRate: 0.01;
                      totalSameDayShippingPurchaseCount: 20;
                      totalTwoDayShippingPurchaseCount: 50;
                  };
                  searchQueryData: {
                      searchQuery: "wireless headphones";
                      searchQueryScore: 5;
                      searchQueryVolume: 15000;
                  };
                  startDate: "2025-01-05";
              },
          ];
          reportSpecification: {
              dataEndTime: "2025-01-11";
              dataStartTime: "2025-01-05";
              marketplaceIds: readonly ["ATVPDKIKX0DER"];
              reportOptions: { asin: "B123456789"; reportPeriod: "WEEK" };
              reportType: "GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT";
          };
      },
  ]

• Readonlyproperties: {
      dataByAsin: {
          items: { $ref: "#/definitions/SearchQueryPerformanceData" };
          type: "array";
      };
      reportSpecification: {
          description: "Summarizes the original report request.";
          examples: readonly [
              {
                  dataEndTime: "2025-01-11";
                  dataStartTime: "2025-01-05";
                  marketplaceIds: readonly ["ATVPDKIKX0DER"];
                  reportOptions: { asin: "B123456789"; reportPeriod: "WEEK" };
                  reportType: "GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT";
              },
          ];
          properties: {
              dataEndTime: {
                  description: "The end date of the report (Amazon ignores the time component). For WEEK, MONTH, and QUARTER reportPeriods, this value must correspond to the last day in the reportPeriod that you specify or else a fatal error returns. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.";
                  examples: readonly ["2025-01-11"];
                  format: "date";
                  type: "string";
              };
              dataStartTime: {
                  description: "The start date of the report (Amazon ignores the time component). For WEEK, MONTH, and QUARTER reportPeriods, this value must correspond to the first day in the reportPeriod that you specify or else a fatal error returns. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.";
                  examples: readonly ["2025-01-05"];
                  format: "date";
                  type: "string";
              };
              marketplaceIds: {
                  description: "This parameter must match the marketplaceId of the selling partner account. This report type supports only one marketplaceId per report. If you specify multiple marketplaces, a fatal error returns and report generation fails.";
                  examples: readonly [readonly ["ATVPDKIKX0DER"]];
                  items: { type: "string" };
                  type: "array";
              };
              reportOptions: {
                  description: "The report options that specify parameters, such as reportPeriod and asin.";
                  properties: {
                      asin: {
                          description: "The Amazon Standard Identification Number.";
                          examples: readonly ["B123456789"];
                          type: "string";
                      };
                      reportPeriod: {
                          description: "The granularity of the data in the report. Valid values are WEEK, MONTH, and QUARTER.";
                          enum: readonly ["WEEK", "MONTH", "QUARTER"];
                          type: "string";
                      };
                  };
                  required: readonly ["reportPeriod", "asin"];
                  type: "object";
              };
              reportType: {
                  description: "The type of the report.";
                  enum: readonly ["GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT"];
                  type: "string";
              };
          };
          required: readonly [
              "reportType",
              "reportOptions",
              "dataStartTime",
              "dataEndTime",
              "marketplaceIds",
          ];
          type: "object";
      };
  }

• Readonlyrequired: readonly ["reportSpecification", "dataByAsin"]

• Readonlytype: "object"