Variable sellingPartnerSearchCatalogPerformanceReportConst
sellingPartnerSearchCatalogPerformanceReport: {
definitions: {
CurrencyAmount: {
description: "Represents an amount of money in a specific currency.";
properties: {
amount: {
description: "The monetary amount.";
examples: readonly [19.99, 999.5];
type: "number";
};
currencyCode: {
description: "The 3-letter currency code in ISO 4217 format.";
examples: readonly ["USD", "EUR", "JPY"];
pattern: "[A-Z]{3}";
type: "string";
};
};
required: readonly ["amount", "currencyCode"];
type: "object";
};
SearchCatalogPerformanceCartAddData: {
description: "The search attributed cart-add data for your catalog.";
properties: {
cartAddCount: {
description: "The number of times customers add an ASIN to a cart. This data originates from the search results page.";
examples: readonly [100];
type: "integer";
};
cartAddedMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
oneDayShippingCartAddCount: {
description: "The number of times customers add an ASIN to a cart with the one-day delivery message in the search results page.";
examples: readonly [30];
type: "integer";
};
sameDayShippingCartAddCount: {
description: "The number of times customers add an ASIN to a cart with the same day delivery message in the search results page.";
examples: readonly [50];
type: "integer";
};
twoDayShippingCartAddCount: {
description: "The number of times customers add an ASIN to a cart with the two-day delivery message in the search results page.";
examples: readonly [20];
type: "integer";
};
};
required: readonly [
"cartAddCount",
"cartAddedMedianPrice",
"sameDayShippingCartAddCount",
"oneDayShippingCartAddCount",
"twoDayShippingCartAddCount",
];
type: "object";
};
SearchCatalogPerformanceClickData: {
description: "The search click data for your catalog.";
properties: {
clickCount: {
description: "The total number of clicks on the ASIN that originates from the search results page.";
examples: readonly [1000];
type: "integer";
};
clickedMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
clickRate: {
description: "The number of clicks divided by the number of impressions for the ASIN.";
examples: readonly [0.1];
type: "number";
};
oneDayShippingClickCount: {
description: "The number of times customers click on the ASIN with the one-day delivery message on the search results page.";
examples: readonly [300];
type: "integer";
};
sameDayShippingClickCount: {
description: "The number of times customers click on the ASIN with the same day delivery message on the search results page.";
examples: readonly [500];
type: "integer";
};
twoDayShippingClickCount: {
description: "The number of times customers click on the ASIN with the two-day delivery message on the search results page.";
examples: readonly [200];
type: "integer";
};
};
required: readonly [
"clickCount",
"clickRate",
"clickedMedianPrice",
"sameDayShippingClickCount",
"oneDayShippingClickCount",
"twoDayShippingClickCount",
];
type: "object";
};
SearchCatalogPerformanceData: {
description: "Contains search catalog performance data for ASINs in the selling partner's catalog.";
examples: readonly [
{
asin: "B123456789";
cartAddData: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
{
asin: "B987654321";
cartAddData: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
];
properties: {
asin: {
description: "The Amazon Standard Identification Number.";
examples: readonly ["B123456789"];
type: "string";
};
cartAddData: {
$ref: "#/definitions/SearchCatalogPerformanceCartAddData";
};
clickData: { $ref: "#/definitions/SearchCatalogPerformanceClickData" };
endDate: {
description: "The end date of the data for the ASIN that you specify in the asin property.";
examples: readonly ["2025-01-11"];
format: "date";
type: "string";
};
impressionData: {
$ref: "#/definitions/SearchCatalogPerformanceImpressionData";
};
purchaseData: {
$ref: "#/definitions/SearchCatalogPerformancePurchaseData";
};
startDate: {
description: "The start date of the data for the ASIN that you specify in the asin property.";
examples: readonly ["2025-01-05"];
format: "date";
type: "string";
};
};
required: readonly [
"startDate",
"endDate",
"asin",
"impressionData",
"clickData",
"cartAddData",
"purchaseData",
];
type: "object";
};
SearchCatalogPerformanceImpressionData: {
description: "The search impression data for your catalog.";
properties: {
impressionCount: {
description: "Total number of impressions for the given ASIN, which originates from the search results page across all search queries. Amazon counts an impression every time the ASIN displays in the search results page. Impressions include sponsored search results.";
examples: readonly [10000];
type: "integer";
};
impressionMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
oneDayShippingImpressionCount: {
description: "The number of times the impressed ASIN displays with the one-day delivery message in a search results page.";
examples: readonly [3000];
type: "integer";
};
sameDayShippingImpressionCount: {
description: "The number of times the impressed ASIN displays with the same day delivery message in a search results page.";
examples: readonly [5000];
type: "integer";
};
twoDayShippingImpressionCount: {
description: "The number of times the impressed ASIN displays with the two-day delivery message in a search results page.";
examples: readonly [2000];
type: "integer";
};
};
required: readonly [
"impressionCount",
"impressionMedianPrice",
"sameDayShippingImpressionCount",
"oneDayShippingImpressionCount",
"twoDayShippingImpressionCount",
];
type: "object";
};
SearchCatalogPerformancePurchaseData: {
description: "The search attributed purchase data for your catalog.";
properties: {
conversionRate: {
description: "The number of purchases divided by the number of clicks for the ASIN.";
examples: readonly [0.05];
type: "number";
};
oneDayShippingPurchaseCount: {
description: "The number of times customers purchase an ASIN with the one-day delivery message in the search results page.";
examples: readonly [15];
type: "integer";
};
purchaseCount: {
description: "The total number of purchases for an ASIN. This data originates from the search results page.";
examples: readonly [50];
type: "integer";
};
purchaseMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
sameDayShippingPurchaseCount: {
description: "The number of times customers purchase an ASIN with the same day delivery message in the search results page.";
examples: readonly [25];
type: "integer";
};
searchTrafficSales: { $ref: "#/definitions/CurrencyAmount" };
twoDayShippingPurchaseCount: {
description: "The number of times customers purchase an ASIN with the two-day delivery message in the search results page.";
examples: readonly [10];
type: "integer";
};
};
required: readonly [
"purchaseCount",
"searchTrafficSales",
"conversionRate",
"purchaseMedianPrice",
"sameDayShippingPurchaseCount",
"oneDayShippingPurchaseCount",
"twoDayShippingPurchaseCount",
];
type: "object";
};
};
description: "The Search Catalog Performance report provides search engagement metrics, such as impressions, clicks, cart adds, and purchases for a date range that you specify. The 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.";
examples: readonly [
{
dataByAsin: readonly [
{
asin: "B123456789";
cartAddData: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
{
asin: "B987654321";
cartAddData: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
];
reportSpecification: {
dataEndTime: "2025-01-11";
dataStartTime: "2025-01-05";
marketplaceIds: readonly ["ATVPDKIKX0DER"];
reportOptions: { asins: "B123456789 B987654321"; reportPeriod: "WEEK" };
reportType: "GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT";
};
},
];
properties: {
dataByAsin: {
items: { $ref: "#/definitions/SearchCatalogPerformanceData" };
type: "array";
};
reportSpecification: {
description: "Summarizes the original report request.";
examples: readonly [
{
dataEndTime: "2025-01-11";
dataStartTime: "2025-01-05";
marketplaceIds: readonly ["ATVPDKIKX0DER"];
reportOptions: { asins: "B123456789 B987654321"; reportPeriod: "WEEK" };
reportType: "GET_BRAND_ANALYTICS_SEARCH_CATALOG_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.";
properties: {
asins: {
description: "A space-separated list of Amazon Standard Identification Number (ASINs) for which you can request the report. If you do not provide ASINs, the report returns search catalog performance data for all ASINs for which you are a brand owner. There is a 200-character limit.";
examples: readonly ["B123456789 B987654321"];
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"];
type: "object";
};
reportType: {
description: "The type of the report.";
enum: readonly [
"GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT",
];
type: "string";
};
};
required: readonly [
"reportType",
"reportOptions",
"dataStartTime",
"dataEndTime",
"marketplaceIds",
];
type: "object";
};
};
required: readonly ["reportSpecification", "dataByAsin"];
type: "object";
} = ...
Type declaration
Readonlydefinitions: {
CurrencyAmount: {
description: "Represents an amount of money in a specific currency.";
properties: {
amount: {
description: "The monetary amount.";
examples: readonly [19.99, 999.5];
type: "number";
};
currencyCode: {
description: "The 3-letter currency code in ISO 4217 format.";
examples: readonly ["USD", "EUR", "JPY"];
pattern: "[A-Z]{3}";
type: "string";
};
};
required: readonly ["amount", "currencyCode"];
type: "object";
};
SearchCatalogPerformanceCartAddData: {
description: "The search attributed cart-add data for your catalog.";
properties: {
cartAddCount: {
description: "The number of times customers add an ASIN to a cart. This data originates from the search results page.";
examples: readonly [100];
type: "integer";
};
cartAddedMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
oneDayShippingCartAddCount: {
description: "The number of times customers add an ASIN to a cart with the one-day delivery message in the search results page.";
examples: readonly [30];
type: "integer";
};
sameDayShippingCartAddCount: {
description: "The number of times customers add an ASIN to a cart with the same day delivery message in the search results page.";
examples: readonly [50];
type: "integer";
};
twoDayShippingCartAddCount: {
description: "The number of times customers add an ASIN to a cart with the two-day delivery message in the search results page.";
examples: readonly [20];
type: "integer";
};
};
required: readonly [
"cartAddCount",
"cartAddedMedianPrice",
"sameDayShippingCartAddCount",
"oneDayShippingCartAddCount",
"twoDayShippingCartAddCount",
];
type: "object";
};
SearchCatalogPerformanceClickData: {
description: "The search click data for your catalog.";
properties: {
clickCount: {
description: "The total number of clicks on the ASIN that originates from the search results page.";
examples: readonly [1000];
type: "integer";
};
clickedMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
clickRate: {
description: "The number of clicks divided by the number of impressions for the ASIN.";
examples: readonly [0.1];
type: "number";
};
oneDayShippingClickCount: {
description: "The number of times customers click on the ASIN with the one-day delivery message on the search results page.";
examples: readonly [300];
type: "integer";
};
sameDayShippingClickCount: {
description: "The number of times customers click on the ASIN with the same day delivery message on the search results page.";
examples: readonly [500];
type: "integer";
};
twoDayShippingClickCount: {
description: "The number of times customers click on the ASIN with the two-day delivery message on the search results page.";
examples: readonly [200];
type: "integer";
};
};
required: readonly [
"clickCount",
"clickRate",
"clickedMedianPrice",
"sameDayShippingClickCount",
"oneDayShippingClickCount",
"twoDayShippingClickCount",
];
type: "object";
};
SearchCatalogPerformanceData: {
description: "Contains search catalog performance data for ASINs in the selling partner's catalog.";
examples: readonly [
{
asin: "B123456789";
cartAddData: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
{
asin: "B987654321";
cartAddData: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
];
properties: {
asin: {
description: "The Amazon Standard Identification Number.";
examples: readonly ["B123456789"];
type: "string";
};
cartAddData: {
$ref: "#/definitions/SearchCatalogPerformanceCartAddData";
};
clickData: { $ref: "#/definitions/SearchCatalogPerformanceClickData" };
endDate: {
description: "The end date of the data for the ASIN that you specify in the asin property.";
examples: readonly ["2025-01-11"];
format: "date";
type: "string";
};
impressionData: {
$ref: "#/definitions/SearchCatalogPerformanceImpressionData";
};
purchaseData: {
$ref: "#/definitions/SearchCatalogPerformancePurchaseData";
};
startDate: {
description: "The start date of the data for the ASIN that you specify in the asin property.";
examples: readonly ["2025-01-05"];
format: "date";
type: "string";
};
};
required: readonly [
"startDate",
"endDate",
"asin",
"impressionData",
"clickData",
"cartAddData",
"purchaseData",
];
type: "object";
};
SearchCatalogPerformanceImpressionData: {
description: "The search impression data for your catalog.";
properties: {
impressionCount: {
description: "Total number of impressions for the given ASIN, which originates from the search results page across all search queries. Amazon counts an impression every time the ASIN displays in the search results page. Impressions include sponsored search results.";
examples: readonly [10000];
type: "integer";
};
impressionMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
oneDayShippingImpressionCount: {
description: "The number of times the impressed ASIN displays with the one-day delivery message in a search results page.";
examples: readonly [3000];
type: "integer";
};
sameDayShippingImpressionCount: {
description: "The number of times the impressed ASIN displays with the same day delivery message in a search results page.";
examples: readonly [5000];
type: "integer";
};
twoDayShippingImpressionCount: {
description: "The number of times the impressed ASIN displays with the two-day delivery message in a search results page.";
examples: readonly [2000];
type: "integer";
};
};
required: readonly [
"impressionCount",
"impressionMedianPrice",
"sameDayShippingImpressionCount",
"oneDayShippingImpressionCount",
"twoDayShippingImpressionCount",
];
type: "object";
};
SearchCatalogPerformancePurchaseData: {
description: "The search attributed purchase data for your catalog.";
properties: {
conversionRate: {
description: "The number of purchases divided by the number of clicks for the ASIN.";
examples: readonly [0.05];
type: "number";
};
oneDayShippingPurchaseCount: {
description: "The number of times customers purchase an ASIN with the one-day delivery message in the search results page.";
examples: readonly [15];
type: "integer";
};
purchaseCount: {
description: "The total number of purchases for an ASIN. This data originates from the search results page.";
examples: readonly [50];
type: "integer";
};
purchaseMedianPrice: { $ref: "#/definitions/CurrencyAmount" };
sameDayShippingPurchaseCount: {
description: "The number of times customers purchase an ASIN with the same day delivery message in the search results page.";
examples: readonly [25];
type: "integer";
};
searchTrafficSales: { $ref: "#/definitions/CurrencyAmount" };
twoDayShippingPurchaseCount: {
description: "The number of times customers purchase an ASIN with the two-day delivery message in the search results page.";
examples: readonly [10];
type: "integer";
};
};
required: readonly [
"purchaseCount",
"searchTrafficSales",
"conversionRate",
"purchaseMedianPrice",
"sameDayShippingPurchaseCount",
"oneDayShippingPurchaseCount",
"twoDayShippingPurchaseCount",
];
type: "object";
};
}
Readonlydescription: "The Search Catalog Performance report provides search engagement metrics, such as impressions, clicks, cart adds, and purchases for a date range that you specify. The 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: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
{
asin: "B987654321";
cartAddData: {
cartAddCount: 100;
cartAddedMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingCartAddCount: 30;
sameDayShippingCartAddCount: 50;
twoDayShippingCartAddCount: 20;
};
clickData: {
clickCount: 1000;
clickedMedianPrice: { amount: 19.99; currencyCode: "USD" };
clickRate: 0.1;
oneDayShippingClickCount: 300;
sameDayShippingClickCount: 500;
twoDayShippingClickCount: 200;
};
endDate: "2025-01-11";
impressionData: {
impressionCount: 10000;
impressionMedianPrice: { amount: 19.99; currencyCode: "USD" };
oneDayShippingImpressionCount: 3000;
sameDayShippingImpressionCount: 5000;
twoDayShippingImpressionCount: 2000;
};
purchaseData: {
conversionRate: 0.05;
oneDayShippingPurchaseCount: 15;
purchaseCount: 50;
purchaseMedianPrice: { amount: 19.99; currencyCode: "USD" };
sameDayShippingPurchaseCount: 25;
searchTrafficSales: { amount: 999.5; currencyCode: "USD" };
twoDayShippingPurchaseCount: 10;
};
startDate: "2025-01-05";
},
];
reportSpecification: {
dataEndTime: "2025-01-11";
dataStartTime: "2025-01-05";
marketplaceIds: readonly ["ATVPDKIKX0DER"];
reportOptions: { asins: "B123456789 B987654321"; reportPeriod: "WEEK" };
reportType: "GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT";
};
},
]
Readonlyproperties: {
dataByAsin: {
items: { $ref: "#/definitions/SearchCatalogPerformanceData" };
type: "array";
};
reportSpecification: {
description: "Summarizes the original report request.";
examples: readonly [
{
dataEndTime: "2025-01-11";
dataStartTime: "2025-01-05";
marketplaceIds: readonly ["ATVPDKIKX0DER"];
reportOptions: { asins: "B123456789 B987654321"; reportPeriod: "WEEK" };
reportType: "GET_BRAND_ANALYTICS_SEARCH_CATALOG_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.";
properties: {
asins: {
description: "A space-separated list of Amazon Standard Identification Number (ASINs) for which you can request the report. If you do not provide ASINs, the report returns search catalog performance data for all ASINs for which you are a brand owner. There is a 200-character limit.";
examples: readonly ["B123456789 B987654321"];
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"];
type: "object";
};
reportType: {
description: "The type of the report.";
enum: readonly ["GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT"];
type: "string";
};
};
required: readonly [
"reportType",
"reportOptions",
"dataStartTime",
"dataEndTime",
"marketplaceIds",
];
type: "object";
};
}
Readonlyrequired: readonly ["reportSpecification", "dataByAsin"]
Readonlytype: "object"