HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

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
11

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.

string
enum

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

Show Details
WEEKISO Calendar Week.
MONTHISO Calendar Month.
QUARTERISO Calendar Quarter.
YEARISO Calendar Year.
Allowed:
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-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.

metrics
array of objects
length ≥ 1

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

string
enum
required

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

Show Details
PERFORMANCEIndicates past performance metrics.
FORECASTIndicates forecasted metrics. Only `TOTAL_SUBSCRIPTIONS_REVENUE` and `SHIPPED_SUBSCRIPTION_UNITS` are supported. Forecast data is supported for sellers but not for vendors.
Allowed:
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 objects
required
length ≥ 1

A list of replenishment program types.

Responses

Updated over 1 year ago

Language
Response 
 Choose an example:
application/json
Updated over 1 year ago