--- title: "getSellingPartnerMetrics" method: POST path: "/replenishment/2022-11-07/sellingPartners/metrics/search" tags: ["Replenishment v2022-11-07"] --- # getSellingPartnerMetrics `POST /replenishment/2022-11-07/sellingPartners/metrics/search` Returns aggregated replenishment program metrics for a selling partner. **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 - GetSellingPartnerMetricsRequest — The request body for the `getSellingPartnerMetrics` operation. - `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. - `metrics` Metric[] — The list of metrics requested. If no metric value is provided, data for all metrics will be returned. - `filters` GetSellingPartnerMetricsRequestFilters — 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. - `asins` string[] — A list of Amazon Standard Identification Numbers (ASINs) to filter by. ASIN filter is supported for these metrics: SHIPPED_SUBSCRIPTION_UNITS, TOTAL_SUBSCRIPTIONS_REVENUE, ACTIVE_SUBSCRIPTIONS, NOT_DELIVERED_DUE_TO_OOS, LOST_REVENUE_DUE_TO_OOS, COUPONS_REVENUE_PENETRATION, SHARE_OF_COUPON_SUBSCRIPTIONS and REVENUE_PENETRATION. - `skus` string[] — [Applicable only for Sellers] A list of SKUs to filter by. SKU filter is supported for these metrics: SHIPPED_SUBSCRIPTION_UNITS, TOTAL_SUBSCRIPTIONS_REVENUE, ACTIVE_SUBSCRIPTIONS, NOT_DELIVERED_DUE_TO_OOS, LOST_REVENUE_DUE_TO_OOS, COUPONS_REVENUE_PENETRATION, SHARE_OF_COUPON_SUBSCRIPTIONS and REVENUE_PENETRATION. - `fulfillmentChannelTypes` FulfillmentChannelType[] — [Applicable only for Sellers] The fulfillment channel types to filter by. Fulfillment channel type filter is supported for these metrics: SHIPPED_SUBSCRIPTION_UNITS, TOTAL_SUBSCRIPTIONS_REVENUE, ACTIVE_SUBSCRIPTIONS, NOT_DELIVERED_DUE_TO_OOS, LOST_REVENUE_DUE_TO_OOS, COUPONS_REVENUE_PENETRATION, SHARE_OF_COUPON_SUBSCRIPTIONS and REVENUE_PENETRATION. - `brandNames` string[] — [Applicable only for US marketplace] A list of brand names to filter by. Brand name filter is supported for these metrics: SHIPPED_SUBSCRIPTION_UNITS, TOTAL_SUBSCRIPTIONS_REVENUE, ACTIVE_SUBSCRIPTIONS, NOT_DELIVERED_DUE_TO_OOS, LOST_REVENUE_DUE_TO_OOS, COUPONS_REVENUE_PENETRATION, SHARE_OF_COUPON_SUBSCRIPTIONS, REVENUE_PENETRATION, SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE, SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS, REVENUE_BY_DELIVERIES, SUBSCRIBER_RETENTION, REVENUE_PENETRATION_BY_SELLER_FUNDING, SUBSCRIBER_LIFETIME_VALUE_BY_CUSTOMER_SEGMENT and SIGNUP_CONVERSION_BY_SELLER_FUNDING. - `productGroups` string[] — [Applicable only for Vendors] A list of product group names to filter by. Product group filter is supported for these metrics: SHIPPED_SUBSCRIPTION_UNITS, TOTAL_SUBSCRIPTIONS_REVENUE, ACTIVE_SUBSCRIPTIONS, NOT_DELIVERED_DUE_TO_OOS, LOST_REVENUE_DUE_TO_OOS, COUPONS_REVENUE_PENETRATION, SHARE_OF_COUPON_SUBSCRIPTIONS and REVENUE_PENETRATION. - `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. ## Response `200` Success. - GetSellingPartnerMetricsResponse — The response schema for the `getSellingPartnerMetrics` operation. - `metrics` GetSellingPartnerMetricsResponseMetric[] — A list of metrics data for the selling partner. - `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 for both the `PERFORMANCE` and `FORECAST` `timePeriodType`. - `shippedSubscriptionUnits` number — The number of units shipped to the subscribers over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`. - `activeSubscriptions` number — The number of active subscriptions present at the end of the period. Applicable to `PERFORMANCE` `timePeriodType`. - `subscriberAverageRevenue` number, double — The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable to `PERFORMANCE` `timePeriodType`. - `nonSubscriberAverageRevenue` number, double — The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. 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`. - `subscriberAverageReorders` number, double — The average reorders per subscriber of the program over a period of 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `nonSubscriberAverageReorders` number, double — The average reorders per non-subscriber of the program over a period of past 12 months. 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`. - `revenueFromSubscriptionsWithMultipleDeliveries` number, double — The subscription revenue generated from subscriptions with over two deliveries over the past 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `revenueFromActiveSubscriptionsWithSingleDelivery` number, double — The subscription revenue generated from active subscriptions with one delivery over the past 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `revenueFromCancelledSubscriptionsAfterSingleDelivery` number, double — The subscription revenue generated from subscriptions which are cancelled after one delivery over the past 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `subscriberRetentionFor30Days` number, double — The percentage of subscriptions retained after 30 days of subscription creation. Applicable to `PERFORMANCE` `timePeriodType`. - `subscriberRetentionFor90Days` number, double — The percentage of subscriptions retained after 90 days of subscription creation. Applicable to `PERFORMANCE` `timePeriodType`. - `revenuePenetrationFor0PercentSellerFunding` number, double — The percentage of subscription revenue generated by offers with 0% seller-funded discount over the last 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `revenuePenetrationFor5PercentSellerFunding` number, double — [Applicable only for Sellers] The percentage of subscription revenue generated by offers with 5% seller-funded discount over the last 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `revenuePenetrationFor10PercentSellerFunding` number, double — [Applicable only for Sellers] The percentage of subscription revenue generated by offers with 10% seller-funded discount over the last 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `revenuePenetrationFor5PlusPercentSellerFunding` number, double — [Applicable only for vendors] The percentage of subscription revenue generated by offers with 5% or above seller-funded discount over the last 12 months. Applicable to `PERFORMANCE` `timePeriodType`. - `shareOfCouponSubscriptions` number, double — The percentage of new subscriptions from coupons. Applicable to `PERFORMANCE` `timePeriodType`. - `nonSubscriberLifeTimeValueFromOTP` number, double — Total revenue from customers who have made purchases from your catalog but have never subscribed to any products. - `lostSubscriberLifeTimeValueFromOTP` number, double — Revenue from one-time purchase orders placed by customers who previously had subscriptions but currently have none active in your catalog. - `lostSubscriberLifeTimeValueFromSNS` number, double — Revenue from Subscribe & Save orders placed by customers who previously had subscriptions but currently have none active in your catalog. - `growingSubscriberLifeTimeValueFromOTP` number, double — Revenue from one-time purchase orders placed by customers who started their first subscription with your catalog within the past 12 months. - `growingSubscriberLifeTimeValueFromSNS` number, double — Revenue from Subscribe & Save orders placed by customers who started their first subscription with your catalog within the past 12 months. - `establishedSubscriberLifeTimeValueFromOTP` number, double — Revenue from one-time purchase orders placed by customers who have maintained an active subscription with your catalog for more than 12 months. - `establishedSubscriberLifeTimeValueFromSNS` number, double — Revenue from Subscribe & Save orders placed by customers who have maintained an active subscription with your catalog for more than 12 months. - `signupConversionFor0PercentSellerFunding` number, double — Percentage of subscriptions from offers with 0% seller-funded discount out of the total number of new orders placed over the past 12 months. - `signupConversionFor5PercentSellerFunding` number, double — [Applicable only for Sellers] Percentage of subscriptions from offers with 5% seller-funded discount out of the total number of new orders placed over the past 12 months. - `signupConversionFor10PercentSellerFunding` number, double — [Applicable only for Sellers] Percentage of subscriptions from offers with 10% seller-funded discount out of the total number of new orders placed over the past 12 months. - `signupConversionFor5PlusPercentSellerFunding` number, double — [Applicable only for Vendors] Percentage of subscriptions from offers with 5% or above seller-funded discount out of the total number of new orders placed over the past 12 months. - `revenuePenetration` number, double — The percentage of total program revenue out of total product revenue over a period of time. Applicable to `PERFORMANCE` `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. ## 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)