getSellingPartnerMetrics

post https://sellingpartnerapi-na.amazon.com/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.

Body Params

The request body for the getSellingPartnerMetrics operation.

aggregationFrequency

string

The time period used to group data in the response. Note that this is only valid for the PERFORMANCE time period type.

Show Details

WEEK	ISO Calendar Week.
MONTH	ISO Calendar Month.
QUARTER	ISO Calendar Quarter.
YEAR	ISO Calendar Year.

timeInterval

object

required

A date-time interval in ISO 8601 format which is 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-07T00: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.

metrics

array of strings

length ≥ 1

The list of metrics requested. If no metric value is provided, data for all of the metrics will be returned.

Show Details

SHIPPED_SUBSCRIPTION_UNITS	The number of units shipped to the subscribers over a period of time.
TOTAL_SUBSCRIPTIONS_REVENUE	The revenue generated from subscriptions over a period of time.
ACTIVE_SUBSCRIPTIONS	The number of active subscriptions present at the end of the period.
NOT_DELIVERED_DUE_TO_OOS	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.
SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE	The average revenue per subscriber and non-subscriber over the past 12 months for sellers and 6 months for vendors.
LOST_REVENUE_DUE_TO_OOS	The revenue that would have been generated had there not been out of stock.
SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS	The average reorders per subscriber and non-subscriber over the last 12 months.
COUPONS_REVENUE_PENETRATION	The percentage of revenue from ASINs with coupons out of total revenue from all ASINs.
REVENUE_BY_DELIVERIES	The subscription revenue generated from subscriptions with over two deliveries, active subscriptions with one delivery and cancelled subscriptions after one delivery over the past 12 months.
SUBSCRIBER_RETENTION	The percentage of subscriptions retained after 30 and 90 days of subscription creation.
REVENUE_PENETRATION_BY_SELLER_FUNDING	The percentage of subscription revenue generated by different tiers of seller-funded discount over the last 12 months.
SHARE_OF_COUPON_SUBSCRIPTIONS	The percentage of new subscriptions acquired through coupons.

timePeriodType

string

required

The time period type that determines whether the metrics requested are backward-looking (performance) or forward-looking (forecast).

Show Details

PERFORMANCE	Indicates past performance metrics.
FORECAST	Indicates forecasted metrics. Only `TOTAL_SUBSCRIPTIONS_REVENUE` and `SHIPPED_SUBSCRIPTION_UNITS` are supported. Forecast data is supported for sellers but not for vendors.

marketplaceId

string

required

The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL. Refer to Marketplace IDs to find the identifier for the marketplace.

programTypes

array of strings

required

length ≥ 1

A list of replenishment program types.

Show Details

SUBSCRIBE_AND_SAVE

Subscribe And Save Program.

Responses

Response body

object

metrics

array of objects

A list of metrics data for the selling partner.

metrics

object

notDeliveredDueToOOS

double

0 to 100

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

double

≥ 0

The revenue generated from subscriptions over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.

shippedSubscriptionUnits

number

≥ 0

The number of units shipped to the subscribers over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.

activeSubscriptions

number

≥ 0

The number of active subscriptions present at the end of the period. Applicable to PERFORMANCE timePeriodType.

subscriberAverageRevenue

double

≥ 0

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

double

≥ 0

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

double

≥ 0

The revenue that would have been generated had there not been out of stock. Applicable to PERFORMANCE timePeriodType.

subscriberAverageReorders

double

≥ 0

The average reorders per subscriber of the program over a period of 12 months. Applicable to PERFORMANCE timePeriodType.

nonSubscriberAverageReorders

double

≥ 0

The average reorders per non-subscriber of the program over a period of past 12 months. Applicable to PERFORMANCE timePeriodType.

couponsRevenuePenetration

double

0 to 100

The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable to PERFORMANCE timePeriodType.

revenueFromSubscriptionsWithMultipleDeliveries

double

≥ 0

The subscription revenue generated from subscriptions with over two deliveries over the past 12 months. Applicable to PERFORMANCE timePeriodType.

revenueFromActiveSubscriptionsWithSingleDelivery

double

≥ 0

The subscription revenue generated from active subscriptions with one delivery over the past 12 months. Applicable to PERFORMANCE timePeriodType.

revenueFromCancelledSubscriptionsAfterSingleDelivery

double

≥ 0

The subscription revenue generated from subscriptions which are cancelled after one delivery over the past 12 months. Applicable to PERFORMANCE timePeriodType.

subscriberRetentionFor30Days

double

0 to 100

The percentage of subscriptions retained after 30 days of subscription creation. Applicable to PERFORMANCE timePeriodType.

subscriberRetentionFor90Days

double

0 to 100

The percentage of subscriptions retained after 90 days of subscription creation. Applicable to PERFORMANCE timePeriodType.

revenuePenetrationFor0PercentSellerFunding

double

0 to 100

The percentage of subscription revenue generated by offers with 0% seller-funded discount over the last 12 months. Applicable to PERFORMANCE timePeriodType.

revenuePenetrationFor5PercentSellerFunding

double

0 to 100

[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

double

0 to 100

[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

double

0 to 100

[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

double

0 to 100

The percentage of new subscriptions acquired through coupons. Applicable to PERFORMANCE timePeriodType.

timeInterval

object

currencyCode

string

The currency code in ISO 4217 format.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "timePeriodType": "PERFORMANCE"
8
}
9
'


xxxxxxxxxx
30
}
1
{
2
  "metrics": [
3
    {
4
      "subscriberAverageRevenue": 125.93,
5
      "nonSubscriberAverageRevenue": 73.62,
6
      "shippedSubscriptionUnits": 5290,
7
      "notDeliveredDueToOOS": 5.54,
8
      "totalSubscriptionsRevenue": 131340.24,
9
      "activeSubscriptions": 0,
10
      "lostRevenueDueToOOS": 38493.29,
11
      "subscriberAverageReorders": 3.25,
12
      "nonSubscriberAverageReorders": 1.11,
13
      "couponsRevenuePenetration": 0,
14
      "revenueFromSubscriptionsWithMultipleDeliveries": 98623.04,
15
      "revenueFromActiveSubscriptionsWithSingleDelivery": 30345.2,
16
      "revenueFromCancelledSubscriptionsAfterSingleDelivery": 2372,
17
      "subscriberRetentionFor30Days": 94.43,
18
      "subscriberRetentionFor90Days": 78.43,
19
      "revenuePenetrationFor0PercentSellerFunding": 10.23,
20
      "revenuePenetrationFor5PercentSellerFunding": 22.2,
21
      "revenuePenetrationFor10PercentSellerFunding": 67.57,
22
      "shareOfCouponSubscriptions": 17.32,
23
      "currencyCode": "USD",
24
      "timeInterval": {
25
        "endDate": "2023-05-09T22:36:56Z",

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The specified resource does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.