--- title: "listOfferMetrics" method: POST path: "/replenishment/2022-11-07/offers/metrics/search" tags: ["Replenishment v2022-11-07"] --- # listOfferMetrics `POST /replenishment/2022-11-07/offers/metrics/search` Returns aggregated replenishment program metrics for a selling partner's offers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). ## Request body - ListOfferMetricsRequest — The request body for the `listOfferMetrics` operation. - `pagination` ListOfferMetricsRequestPagination, required — Use these parameters to paginate through the response. - `limit` integer, required — The maximum number of results to return in the response. - `offset` integer, required — The offset from which to retrieve the number of results specified by the `limit` value. The first result is at offset 0. - `sort` ListOfferMetricsRequestSort — Use these parameters to sort the response. - `order` 'ASC' | 'DESC', required — The sort order. - `key` 'SHIPPED_SUBSCRIPTION_UNITS' | 'TOTAL_SUBSCRIPTIONS_REVENUE' | 'ACTIVE_SUBSCRIPTIONS' | 'NEXT_90DAYS_SHIPPED_SUBSCRIPTION_UNITS' | 'NEXT_60DAYS_SHIPPED_SUBSCRIPTION_UNITS' | 'NEXT_30DAYS_SHIPPED_SUBSCRIPTION_UNITS' | 'NEXT_90DAYS_TOTAL_SUBSCRIPTIONS_REVENUE' | 'NEXT_60DAYS_TOTAL_SUBSCRIPTIONS_REVENUE' | 'NEXT_30DAYS_TOTAL_SUBSCRIPTIONS_REVENUE', required — The attribute to use to sort the results. - `filters` ListOfferMetricsRequestFilters, required — Use these parameters to filter results. Any result must match all provided parameters. For parameters that accept multiple values (arrays), the API returns results that match at least one value in the array. - `aggregationFrequency` 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' — The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type. - `timeInterval` TimeInterval, required — A date-time interval in ISO 8601 format used to compute metrics. Only the date is required, but you must pass the complete date and time value. For example, November 11, 2022 should be passed as "2022-11-11T00:00:00Z". Note that only data for the trailing 2 years is supported. **Note**: * The `listOfferMetrics` operation only supports a time interval which covers a single unit of the aggregation frequency. For example, for a MONTH aggregation frequency, the duration of the interval between the startDate and endDate can not be more than 1 month. * For the `getSellingPartnerMetrics` operation with DAY aggregation frequency, the time interval cannot exceed 31 days. - `startDate` string, date-time, required — When this object is used as a request parameter, the specified `startDate` is adjusted based on the aggregation frequency. * For `DAY` the metric is computed from the specific day indicated by the `startDate`. * For `WEEK` the metric is computed from the first day of the week (Monday, based on ISO 8601) that contains the `startDate`. * For `MONTH` the metric is computed from the first day of the month that contains the `startDate`. * For `QUARTER` the metric is computed from the first day of the quarter that contains the `startDate`. * For `YEAR` the metric is computed from the first day of the year that contains the `startDate`. - `endDate` string, date-time, required — When this object is used as a request parameter, the specified `endDate` is adjusted based on the aggregation frequency. * For `DAY` the metric is computed up to the specific day indicated by the `endDate`. * For `WEEK` the metric is computed up to the last day of the week (Sunday, based on ISO 8601) that contains the `endDate`. * For `MONTH`, the metric is computed up to the last day of the month that contains the `endDate`. * For `QUARTER` the metric is computed up to the last day of the quarter that contains the `endDate`. * For `YEAR` the metric is computed up to the last day of the year that contains the `endDate`. Note: The end date may be adjusted to a lower value based on the data available in our system. - `timePeriodType` 'PERFORMANCE' | 'FORECAST', required — The time period type that determines whether the metrics requested are backward-looking (performance) or forward-looking (forecast). - `marketplaceId` string, required — The identifier of the Amazon marketplace. For the list of all marketplace IDs, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). - `programTypes` ProgramType[], required — A list of replenishment program types. - `asins` string[] — A list of Amazon Standard Identification Numbers (ASINs) to filter by. - `skus` string[] — [Applicable only for Sellers] A list of SKUs to filter by. - `fulfillmentChannelTypes` FulfillmentChannelType[] — [Applicable only for Sellers] The fulfillment channel types to filter by. - `brandNames` string[] — [Applicable only for US marketplace] A list of brand names to filter by. - `productGroups` string[] — [Applicable only for Vendors] A list of product group names to filter by. ## Response `200` Success. - ListOfferMetricsResponse — The response schema for the `listOfferMetrics` operation. - `offers` ListOfferMetricsResponseOffer[] — A list of offers and associated metrics. - `asin` string — The Amazon Standard Identification Number (ASIN). - `sku` string — The SKU. This property is only supported for sellers and not for vendors. - `fulfillmentChannelType` 'AMAZON' | 'MERCHANT' — The fulfillment channel type of an offer. Note that this is only valid for sellers and not for vendors. - `brandName` string — The brand name associated with the offer. - `productGroup` string — The product group associated with the offer. This property is only supported for vendors and not for sellers. - `notDeliveredDueToOOS` number, double — The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable to `PERFORMANCE` `timePeriodType`. - `totalSubscriptionsRevenue` number, double — The revenue generated from subscriptions over a period of time. Applicable to `PERFORMANCE` `timePeriodType`. - `shippedSubscriptionUnits` number — The number of units shipped to the subscribers over a period of time. Applicable to `PERFORMANCE` `timePeriodType`. - `activeSubscriptions` number — The number of active subscriptions present at the end of the period. Applicable to `PERFORMANCE` `timePeriodType`. - `revenuePenetration` number, double — The percentage of total program revenue out of total product revenue. Applicable to `PERFORMANCE` `timePeriodType`. - `lostRevenueDueToOOS` number, double — The revenue that would have been generated had there not been out of stock. Applicable to `PERFORMANCE` `timePeriodType`. - `couponsRevenuePenetration` number, double — The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable to `PERFORMANCE` `timePeriodType`. - `shareOfCouponSubscriptions` number, double — The percentage of new subscriptions from coupons. Applicable to `PERFORMANCE` `timePeriodType`. - `next30DayTotalSubscriptionsRevenue` number, double — The forecasted total subscription revenue for the next 30 days. Applicable to `FORECAST` `timePeriodType`. - `next60DayTotalSubscriptionsRevenue` number, double — The forecasted total subscription revenue for the next 60 days. Applicable to `FORECAST` `timePeriodType`. - `next90DayTotalSubscriptionsRevenue` number, double — The forecasted total subscription revenue for the next 90 days. Applicable to `FORECAST` `timePeriodType`. - `next30DayShippedSubscriptionUnits` number — The forecasted shipped subscription units for the next 30 days. Applicable to `FORECAST` `timePeriodType`. - `next60DayShippedSubscriptionUnits` number — The forecasted shipped subscription units for the next 60 days. Applicable to `FORECAST` `timePeriodType`. - `next90DayShippedSubscriptionUnits` number — The forecasted shipped subscription units for the next 90 days. Applicable to `FORECAST` `timePeriodType`. - `timeInterval` TimeInterval — A date-time interval in ISO 8601 format used to compute metrics. Only the date is required, but you must pass the complete date and time value. For example, November 11, 2022 should be passed as "2022-11-11T00:00:00Z". Note that only data for the trailing 2 years is supported. **Note**: * The `listOfferMetrics` operation only supports a time interval which covers a single unit of the aggregation frequency. For example, for a MONTH aggregation frequency, the duration of the interval between the startDate and endDate can not be more than 1 month. * For the `getSellingPartnerMetrics` operation with DAY aggregation frequency, the time interval cannot exceed 31 days. - `startDate` string, date-time, required — When this object is used as a request parameter, the specified `startDate` is adjusted based on the aggregation frequency. * For `DAY` the metric is computed from the specific day indicated by the `startDate`. * For `WEEK` the metric is computed from the first day of the week (Monday, based on ISO 8601) that contains the `startDate`. * For `MONTH` the metric is computed from the first day of the month that contains the `startDate`. * For `QUARTER` the metric is computed from the first day of the quarter that contains the `startDate`. * For `YEAR` the metric is computed from the first day of the year that contains the `startDate`. - `endDate` string, date-time, required — When this object is used as a request parameter, the specified `endDate` is adjusted based on the aggregation frequency. * For `DAY` the metric is computed up to the specific day indicated by the `endDate`. * For `WEEK` the metric is computed up to the last day of the week (Sunday, based on ISO 8601) that contains the `endDate`. * For `MONTH`, the metric is computed up to the last day of the month that contains the `endDate`. * For `QUARTER` the metric is computed up to the last day of the quarter that contains the `endDate`. * For `YEAR` the metric is computed up to the last day of the year that contains the `endDate`. Note: The end date may be adjusted to a lower value based on the data available in our system. - `currencyCode` string — The currency code in ISO 4217 format. - `pagination` PaginationResponse — Use these parameters to paginate through the response. - `totalResults` integer — Total number of results matching the given filter criteria. ## Other responses - `400` — Request has missing or invalid parameters and cannot be parsed. - `401` — The request's Authorization header is not formatted correctly or does not contain a valid token. - `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. - `404` — The specified resource does not exist. - `413` — The request size exceeded the maximum accepted size. - `415` — The request payload is in an unsupported format. - `429` — The frequency of requests was greater than allowed. - `500` — An unexpected condition occurred that prevented the server from fulfilling the request. - `503` — Temporary overloading or maintenance of the server. --- [API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)