# replenishment_getSellingPartnerMetrics (https://sellersheetai.com/docs/mcp-api/tools/replenishment_getSellingPartnerMetrics)

> Get aggregated, account-level Subscribe & Save replenishment metrics for the selling partner.

Access: **READ** · toolset amazon_sp · family sp.replenishment-2022-11-07

Amazon SP-API · getSellingPartnerMetrics · POST /replenishment/2022-11-07/sellingPartners/metrics/search Returns program-wide numbers (active subscriptions, subscription revenue, OOS loss, retention, revenue penetration) — NOT per-offer data. For per-ASIN drill-down use replenishment_listOfferMetrics.

## Call it

MCP tool call:

```json
{
  "name": "replenishment_getSellingPartnerMetrics",
  "arguments": {
    "store": "myStore-US",
    "timeInterval": {}
  }
}
```

Tool API (early access — contact us):

```bash
curl -X POST https://api.sellersheetai.com/api/v1/tools/replenishment_getSellingPartnerMetrics \
  -H "Authorization: Bearer $SELLERSHEET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store":"myStore-US","timeInterval":{}}'
```

## Arguments

| Name | Type | Required | Description |
|---|---|---|---|
| `store` | string | yes | the store ref `<store>-<CC>` (name-country, e.g. 'myStore-US') — one of get_user_context's store_refs, verbatim. |
| `timeInterval` | object | yes | {startDate, endDate}, both ISO 8601 datetimes with timezone, e.g. {"startDate": "2026-04-01T00:00:00Z", "endDate": "2026-04-30T00:00:00Z"}. |
| `timePeriodType` | string |  | PERFORMANCE (backward-looking; the default when omitted) or FORECAST (forward-looking projection). Allowed: PERFORMANCE \| FORECAST. |
| `aggregationFrequency` | string |  | how to group rows in the response. Amazon REQUIRES it when timePeriodType=PERFORMANCE (else it 400s "aggregationFrequency is required for PERFORMANCE timePeriodType"); omit it with FORECAST. startDate / endDate are widened to whole buckets (WEEK = Monday–Sunday, MONTH = the calendar month, and so on). Allowed: DAY \| WEEK \| MONTH \| QUARTER \| YEAR. Allowed: DAY \| WEEK \| MONTH \| QUARTER \| YEAR. |
| `programTypes` | string[] |  | omit — SUBSCRIBE_AND_SAVE, the only value, is sent for you. |
| `metrics` | string[] |  | optional allowlist of metric names; omit for all. Allowed: SHIPPED_SUBSCRIPTION_UNITS \| TOTAL_SUBSCRIPTIONS_REVENUE \| ACTIVE_SUBSCRIPTIONS \| NOT_DELIVERED_DUE_TO_OOS \| SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE \| LOST_REVENUE_DUE_TO_OOS \| SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS \| COUPONS_REVENUE_PENETRATION \| REVENUE_BY_DELIVERIES \| SUBSCRIBER_RETENTION \| REVENUE_PENETRATION_BY_SELLER_FUNDING \| SHARE_OF_COUPON_SUBSCRIPTIONS \| SUBSCRIBER_LIFETIME_VALUE_BY_CUSTOMER_SEGMENT \| SIGNUP_CONVERSION_BY_SELLER_FUNDING \| REVENUE_PENETRATION. Allowed: SHIPPED_SUBSCRIPTION_UNITS \| TOTAL_SUBSCRIPTIONS_REVENUE \| ACTIVE_SUBSCRIPTIONS \| NOT_DELIVERED_DUE_TO_OOS \| SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE \| LOST_REVENUE_DUE_TO_OOS \| SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS \| COUPONS_REVENUE_PENETRATION \| REVENUE_BY_DELIVERIES \| SUBSCRIBER_RETENTION \| REVENUE_PENETRATION_BY_SELLER_FUNDING \| SHARE_OF_COUPON_SUBSCRIPTIONS \| SUBSCRIBER_LIFETIME_VALUE_BY_CUSTOMER_SEGMENT \| SIGNUP_CONVERSION_BY_SELLER_FUNDING \| REVENUE_PENETRATION. |
| `filters` | object |  | Optional dict (each list maxItems 20, minItems 1): {"asins": [...], "skus": [...] (sellers only), "fulfillmentChannelTypes": [...]  (each AMAZON \| MERCHANT; sellers only), "brandNames": [...] (US only), "productGroups": [...] (vendors only)}. |
| `marketplaceId` | string |  | optional Amazon marketplaceId; defaults to the store ref's marketplace. |

## Result

- `data.result.metrics[]` — per-interval objects (activeSubscriptions, totalSubscriptionsRevenue, shippedSubscriptionUnits, notDeliveredDueToOOS, lostRevenueDueToOOS, subscriberRetentionFor30Days/90Days, revenuePenetration, timeInterval, currencyCode, ...).

## Body (Amazon schema)

- aggregationFrequency: DAY | WEEK | MONTH | QUARTER | YEAR timeInterval*: {startDate*, endDate*} metrics: [SHIPPED_SUBSCRIPTION_UNITS | TOTAL_SUBSCRIPTIONS_REVENUE | ACTIVE_SUBSCRIPTIONS | NOT_DELIVERED_DUE_TO_OOS | SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE | LOST_REVENUE_DUE_TO_OOS | SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS | COUPONS_REVENUE_PENETRATION | REVENUE_BY_DELIVERIES | SUBSCRIBER_RETENTION | REVENUE_PENETRATION_BY_SELLER_FUNDING | SHARE_OF_COUPON_SUBSCRIPTIONS | SUBSCRIBER_LIFETIME_VALUE_BY_CUSTOMER_SEGMENT | SIGNUP_CONVERSION_BY_SELLER_FUNDING | REVENUE_PENETRATION] (min 1) filters: {asins: [string] (1–20), skus: [string] (1–20), fulfillmentChannelTypes: [AMAZON | MERCHANT] (1–2), brandNames: [string] (1–20), productGroups: [string] (1–20)} timePeriodType*: PERFORMANCE | FORECAST marketplaceId*: string programTypes*: [SUBSCRIBE_AND_SAVE] (min 1)