{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"acosMetric":{"description":"Advertising cost of sales (ACOS) is the percentage of sales spent on advertising (total spend / total sales). A lower ACOS infers higher efficiency of your advertising investment relative to your advertising spend. This structure contains the value, median (50th percentile), bottom 25% and top 25% performance quartile values of peers. Peers are aggregated at the category level, and include brands in the same category, with products containing similar features. Note: null is a valid value in these objects and signifies insufficient peers exist to allow the calculation and/or display of the metric or the benchmark.","properties":{"bottom-25pct":{"description":"The value at which 25% of the lower-performing values lie below. For ACOS, since lower ACOS indicates higher performance, 25% of peer values will be above the bottom 25% value. It is similar to the first/lower quartile.","type":"number"},"median":{"description":"The middle value of the data set. Half of the values lie below the median and half lie above the median. It is also known as the 50th percentile.","type":"number"},"top-25pct":{"description":"The value at which 25% of the top performing values lie above. For ACOS, since lower ACOS indicates higher performance, 25% of values will be below the top 25% value. It is similar to the third/upper quartile.","type":"number"},"value":{"description":"ACOS of your ad","type":"number"}},"type":"object"},"brandListResponse":{"description":"A list of brands advertiser has access to","properties":{"brands":{"items":{"properties":{"name":{"type":"string"}},"type":"object"},"type":"array"},"nextPageToken":{"type":"string"}},"type":"object"},"brandsAndCategoriesItem":{"description":"Each item contains the metrics for a single brand-category combination","properties":{"acos":{"$ref":"#/components/schemas/acosMetric"},"brandName":{"type":"string"},"categoryId":{"description":"This is the same as browse node ID","type":"string"},"categoryName":{"type":"string"},"ctr":{"$ref":"#/components/schemas/ctrMetric"},"endDate":{"type":"string"},"impressions":{"$ref":"#/components/schemas/impressionMetric"},"roas":{"$ref":"#/components/schemas/roasMetric"},"startDate":{"type":"string"}},"type":"object"},"ctrMetric":{"description":"Click Through Rate (CTR): The percentage of shoppers who see your ad and also click it, calculated as clicks divided by impressions (clicks / impressions). A higher CTR infers more users are interested in your ad and are engaging with them. This structure contains the value, median (50th percentile), bottom 25% and top 25% performance quartile values of peers. Peers are aggregated at the category level, and include brands in the same category, with products containing similar features. Note: null is a valid value in these objects and signifies insufficient peers exist to allow the calculation and/or display of the metric or the benchmark.","properties":{"bottom-25pct":{"description":"The value at which 25% of the lower-performing values lie below. For CTR, 25% of peer values will be below the bottom 25% value. It is similar to the first/lower quartile.","type":"number"},"median":{"description":"The middle value of the data set. Half of the values lie below the median and half lie above the median. It is also known as the 50th percentile.","type":"number"},"top-25pct":{"description":"The value at which 25% of the top performing values lie above. For CTR, 25% of values will be above the top 25% value. It is similar to the third/upper quartile.","type":"number"},"value":{"description":"CTR of your ad","type":"number"}},"type":"object"},"endDateParam":{"default":"The latest valid endDate","description":"End of the data range (inclusive) in YYYY-MM-DD format (all \u003ca href\u003d\"https://en.wikipedia.org/wiki/ISO_8601#Dates\"\u003eISO_8601\u003c/a\u003e date formats are also supported). The date will be in the Coordinated Universal Time (UTC) timezone.","type":"string"},"errorResponse":{"description":"Response of an error which contains a message","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"granularityParam":{"default":"Defaults to the same value as the window param set","description":"Granularity of time series.","enum":["DAY","MONTH","WEEK"],"type":"string"},"impressionMetric":{"description":"An impression occurs whenever an ad is displayed. The impressions metric is a count of how many times your ad has been served to a user. A higher impression value infers more users are seeing your ads. This structure contains the value, median (50th percentile), bottom 25% and top 25% performance quartile values of peers. Peers are aggregated at the category level, and include brands in the same category, with products containing similar features. Note: null is a valid value in these objects and signifies insufficient peers exist to allow the calculation and/or display of the metric or the benchmark.","properties":{"bottom-25pct":{"description":"The value at which 25% of the lower-performing values lie below. For impressions, 25% of peer values will be below the bottom 25% value. It is similar to the first/lower quartile.","type":"number"},"median":{"description":"The middle value of the data set. Half of the values lie below the median and half lie above the median. It is also known as the 50th percentile.","type":"number"},"top-25pct":{"description":"The value at which 25% of the top performing values lie above. For impressions, 25% of values will be above the top 25% value. It is similar to the third/upper quartile.","type":"number"},"value":{"description":"Number of impressions of your ad","type":"number"}},"type":"object"},"metricsParam":{"default":"Return all available metrics","description":"Metrics to be included in the response.","items":{"enum":["ACOS","CTR","IMPRESSIONS","ROAS"],"type":"string"},"type":"array"},"nextPageTokenParam":{"description":"Pagination token.","type":"string"},"programTypeParam":{"default":"SB","description":"Ad program Type. We currently only support Sponsored Brands (SB).","enum":["SB"],"type":"string"},"reportResponse":{"description":"Response model of an entire benchmark report","properties":{"brandsAndCategories":{"items":{"$ref":"#/components/schemas/brandsAndCategoriesItem"},"type":"array"},"nextPageToken":{"type":"string"}},"type":"object"},"roasMetric":{"description":"Return on advertising spend (ROAS) divides the total sales by the total ad spend (total ad sales / total ad spend). A higher ROAS infers higher efficiency of your advertising investment relative to your advertising spend. This structure contains the value, median (50th percentile), bottom 25% and top 25% performance quartile values of peers. Peers are aggregated at the category level, and include brands in the same category, with products containing similar features. Note: null is a valid value in these objects and signifies insufficient peers exist to allow the calculation and/or display of the metric or the benchmark.","properties":{"bottom-25pct":{"description":"The value at which 25% of the lower-performing values lie below. For ROAS, 25% of peer values will be below the bottom 25% value. It is similar to the first/lower quartile.","type":"number"},"median":{"description":"The middle value of the data set. Half of the values lie below the median and half lie above the median. It is also known as the 50th percentile.","type":"number"},"top-25pct":{"description":"The value at which 25% of the top performing values lie above. For ROAS, 25% of values will be above the top 25% value. It is similar to the third/upper quartile.","type":"number"},"value":{"description":"ROAS of your ad","type":"number"}},"type":"object"},"startDateParam":{"default":"30 days in the past from the endDateParam","description":"Beginning of the data range (inclusive) in YYYY-MM-DD format (all \u003ca href\u003d\"https://en.wikipedia.org/wiki/ISO_8601#Dates\"\u003eISO_8601\u003c/a\u003e date formats are also supported). The startDate cannot be earlier than 90 days in the past from the current date. The date will be in the Coordinated Universal Time (UTC) timezone.","type":"string"},"timeSeriesItem":{"description":"An item in the time series array which represents the data for a single point","properties":{"acos":{"$ref":"#/components/schemas/acosMetric"},"ctr":{"$ref":"#/components/schemas/ctrMetric"},"endDate":{"type":"string"},"impressions":{"$ref":"#/components/schemas/impressionMetric"},"roas":{"$ref":"#/components/schemas/roasMetric"},"startDate":{"type":"string"}},"type":"object"},"timeSeriesResponse":{"description":"Response model of time series data","properties":{"category":{"type":"string"},"nextPageToken":{"type":"string"},"timeSeries":{"items":{"$ref":"#/components/schemas/timeSeriesItem"},"type":"array"}},"type":"object"},"windowParam":{"default":"DAY","description":"Period of aggregation.","enum":["DAY","MONTH","WEEK"],"type":"string"}},"securitySchemes":{}},"info":{"description":"Provides advertising metrics for brands to benchmark themselves against their peers with Sponsored Brands campaigns.","title":"Sponsored Brands Category Benchmark","version":"3.0"},"openapi":"3.0.1","paths":{"/benchmarks/brands":{"get":{"description":"Gets a list of brands that the advertising account has promoted in their SB campaigns\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getBrands","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"pagination token","in":"query","name":"nextPageToken","required":false,"schema":{"type":"string"}},{"description":"Program Type. We currently only support SB","in":"query","name":"programType","required":false,"schema":{"$ref":"#/components/schemas/programTypeParam"}}],"responses":{"200":{"content":{"application/vnd.brandlist.v1+json":{"schema":{"$ref":"#/components/schemas/brandListResponse"}}},"description":"Successful operation."},"401":{"content":{"application/vnd.brandlist.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.brandlist.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Forbidden. The request failed for one of the following reasons:\n - The user is not allowed to invoke the operation\n- The requested resource does not exist\n- The method is not allowed on the requested resource"},"429":{"content":{"application/vnd.brandlist.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.brandlist.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."},"501":{"content":{"application/vnd.brandlist.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"End-point not implemented yet"}},"summary":"Gets a list of brands","tags":["Category Benchmark"]}},"/benchmarks/brands/{brandName}/categories/{categoryId}":{"post":{"description":"Provides time series data for the specified brand and category filtered by optional parameters\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getTimeSeries","parameters":[{"description":"A brand name associated with entity","in":"path","name":"brandName","required":true,"schema":{"type":"string"}},{"description":"Category identifier for brand. This is the same as category ID","in":"path","name":"categoryId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"properties":{"endDate":{"$ref":"#/components/schemas/endDateParam"},"granularity":{"$ref":"#/components/schemas/granularityParam"},"metrics":{"$ref":"#/components/schemas/metricsParam"},"nextPageToken":{"$ref":"#/components/schemas/nextPageTokenParam"},"programType":{"$ref":"#/components/schemas/programTypeParam"},"startDate":{"$ref":"#/components/schemas/startDateParam"},"window":{"$ref":"#/components/schemas/windowParam"}},"required":["metrics"],"type":"object"}}},"description":"Filters applied to data retrieval"},"responses":{"200":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"$ref":"#/components/schemas/timeSeriesResponse"}}},"description":"Successful operation."},"204":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"No content available for this request"},"401":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Forbidden. The request failed for one of the following reasons:\n - The user is not allowed to invoke the operation\n- The requested resource does not exist\n- The method is not allowed on the requested resource"},"429":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."},"501":{"content":{"application/vnd.timeseriesdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"End-point not implemented yet"}},"summary":"Provides time series data","tags":["Category Benchmark"]}},"/benchmarks/brandsAndCategories":{"post":{"description":"Provides overview of metrics for all brands and categories that the entity has access to.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getReportData","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"properties":{"endDate":{"$ref":"#/components/schemas/endDateParam"},"metrics":{"$ref":"#/components/schemas/metricsParam"},"nextPageToken":{"$ref":"#/components/schemas/nextPageTokenParam"},"programType":{"$ref":"#/components/schemas/programTypeParam"},"startDate":{"$ref":"#/components/schemas/startDateParam"}},"type":"object"}}},"description":"Filters applied to data retrieval"},"responses":{"200":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"$ref":"#/components/schemas/reportResponse"}}},"description":"Successful operation."},"204":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"No content available for this request"},"401":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Forbidden. The request failed for one of the following reasons:\n - The user is not allowed to invoke the operation\n- The requested resource does not exist\n- The method is not allowed on the requested resource"},"429":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."},"501":{"content":{"application/vnd.reportdata.v1+json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}},"description":"End-point not implemented yet"}},"summary":"Provides entire report data of peer benchmarks","tags":["Category Benchmark"]}}}}