getSellerStandardsProfile: eBay Analytics API

GET/seller_standards_profile/{program}/{cycle}

This call retrieves a single standards profile for the associated seller.

A standards profile is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD).

A seller can have multiple profiles distinguished by two criteria, a "program" and a "cycle." A profile's program is one of three regions where the seller may have done business, or PROGRAM_GLOBAL to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation (CURRENT) or at the time of the request (PROJECTED). Both cycle and a program values are required URI parameters for this method.

Input

Resource URI

GET https://api.ebay.com/sell/analytics/v1/seller_standards_profile/{program}/{cycle}

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

Parameter	Type	Description
program	string	This path parameter is used to specify the seller standards program for which metrics and metadata will be retrieved. See ProgramEnum for a list of supported values. Occurrence: Required
cycle	string	This path parameter is used to specify the cycle for which metrics and metadata will be retrieved. See CycleTypeEnum for a list of supported values. Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.analytics.readonly

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* StandardsProfile */

"cycle" :

{ /* Cycle */

"cycleType" : "CycleTypeEnum : [CURRENT,PROJECTED]",

"evaluationDate" : "string",

"evaluationMonth" : "string"

"defaultProgram" : "boolean",

"evaluationReason" : "string",

"metrics" : [

{ /* Metric */

"level" : "StandardsLevelEnum : [TOP_RATED,ABOVE_STANDARD,BELOW_STANDARD]",

"lookbackEndDate" : "string",

"lookbackStartDate" : "string",

"metricKey" : "string",

"name" : "string",

"thresholdLowerBound" : "any",

"thresholdMetaData" : "string",

"thresholdUpperBound" : "any",

"type" : "DataTypeEnum : [AMOUNT,BOOLEAN,DATE...]",

"value" : "any"

}

"program" : "ProgramEnum : [PROGRAM_DE,PROGRAM_UK,PROGRAM_US...]",

"standardsLevel" : "StandardsLevelEnum : [TOP_RATED,ABOVE_STANDARD,BELOW_STANDARD]"

}

Response fields

Output container/field	Type	Description
cycle	Cycle	A complex type that specifies the profile's evaluation cycle (`CURRENT` or `PROJECTED`), the date the evaluation was calculated, and the month to which the evaluation pertains. Each program has at least one cycle, but a program can include both cycle types. Occurrence: Conditional
cycle.cycleType	CycleTypeEnum	The cycle type, either `CURRENT` or `PROJECTED`. `CURRENT` means the profile's metrics values are from the most recent official eBay monthly standards evaluation. `PROJECTED` means the profile values were determined when the profile was requested. Occurrence: Conditional
cycle.evaluationDate	string	The date and time at which the standard compliance values were determined for the profile. The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock. Format: `[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z` Example: `2018-08-04T07:09:00.000Z` Occurrence: Conditional
cycle.evaluationMonth	string	The month in which the currently effective seller level was computed. The value is always formatted as `YYYY-MM`. If the cycle is `CURRENT`, this value is the month and year the of the last eBay compliance evaluation. If this is for a `PROJECTED` cycle, the value is the month and year of the next scheduled evaluation. Because eBay does official evaluations around the 20th of each month, a `PROJECTED` value may indicate either the current or the next month. Occurrence: Conditional
defaultProgram	boolean	If set to `true`, this flag indicates this is the default program for the seller. Except for sellers in China, a seller's default program is the marketplace where they registered with eBay. Seller's in China select their default program when they register. Occurrence: Conditional
evaluationReason	string	Specifies how the overall seller level was calculated. In the event of special circumstances (as determined by eBay), eBay may override the calculated seller level. In general, such overrides protect a seller's level. The usual value for both cycle types is "Seller level generated by standards monthly evaluation cycle." Occurrence: Conditional
metrics	array of Metric	A list of the metrics upon which a seller's profile is evaluated. Each program's applicable metrics and requirements are listed at eBay Top Rated seller program standards. Occurrence: Conditional
metrics.level	StandardsLevelEnum	The seller level for this metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. Occurrence: Conditional
metrics.lookbackEndDate	string	The end date and time, in ISO 8601 format, when the seller was evaluated for this metric. Occurrence: Conditional
metrics.lookbackStartDate	string	The start date and time, in ISO 8601 format, when the seller was evaluated for this metric. Occurrence: Conditional
metrics.metricKey	string	An internal key string specifying a metric. These are short, abbreviated, strings such as `MIN_TXN_COUNT`. Occurrence: Conditional
metrics.name	string	A descriptive name for the metric. For example, "Transaction defect rate." This value is localized according to the value of the X-EBAY-C-MARKETPLACE-ID request header. Occurrence: Conditional
metrics.thresholdLowerBound	any	Specifies the lowest number value can be and still qualify for the currently assigned seller level. For example, if a seller is assigned the level `ABOVE_STANDARD` for the ROCKS_INVENTORY metric, and thresholdLowerBound is set to `10`, having fewer than 10 rocks in inventory would result in the seller dropping a level to `BELOW_STANDARD`. See `thresholdMetaData` to determine if the lower bound value is inclusive or exclusive. The lower bound value is optional. For example, if the seller is below standard for this metric, there is no value they can go below for it to further lower their compliance level. Note that each program can have different metric-threshold levels. Occurrence: Conditional
metrics.thresholdMetaData	string	An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries. A metric's thresholdLowerBound and thresholdUpperBound values specify the boundary values that define the current standard compliance level (`TOP_RATED`, `ABOVE_STANDARD`, or `BELOW_STANDARD`). The thresholdMetaData value consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. A parenthesis indicates the adjacent value is exclusive while a square bracket indicates the adjacent value is inclusive (exclusive values are not included in the range while inclusive values are included). The metadata values are either `UPPER` or `LOWER` and these values can be in any order to indicate the characteristics of the metric. For example, suppose a seller's level is `ABOVE_STANDARD`, the lower boundary is `200`, the upper boundary is `300`, and the value for this field is `(LOWER, UPPER]`. This indicates that as long as the value for this metric is an integer from 201 (excluding 200) to 300 (including 300), the metric level is above standard. With this, if the seller wants to get a `TOP_RATED` rating for this metric, they'll have to increase their value to at least 301. Occurrence: Conditional
metrics.thresholdUpperBound	any	Specifies the highest number value can be and still qualify for the currently assigned seller level. For example, if a seller is assigned the level `ABOVE_STANDARD` for the ROCKS_INVENTORY metric, and the thresholdUpperBound is set to `20`, having more than 20 rocks in inventory would result in the seller rising a lever, to `TOP_RATED`. See `thresholdMetaData` to determine if the upper bound value is inclusive or exclusive. The upper bound value is optional. For example, if the seller is top rated for this metric, there is no value they can go above for it to further raise their compliance level. Note that each program can have different metric-threshold levels. Occurrence: Conditional
metrics.type	DataTypeEnum	Indicates the data type of the returned metric. Possible values are: AMOUNT, BOOLEAN, DATE, FRACTION, NUMBER, and STRING. Occurrence: Conditional
metrics.value	any	The seller's calculated value, or score, for the metric. Occurrence: Conditional
program	ProgramEnum	Indicates the program used to generate the profile data. Values can be `PROGRAM_DE`, `PROGRAM_UK`, `PROGRAM_US`, or `PROGRAM_GLOBAL`. Occurrence: Conditional
standardsLevel	StandardsLevelEnum	The overall standards level of the seller, one of `TOP_RATED`, `ABOVE_STANDARD`, or `BELOW_STANDARD`. Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
200	Success
204	No content
400	Bad Request
404	Resource not found
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
53100	API_ANALYTICS	REQUEST	Program Id cannot be empty.
53105	API_ANALYTICS	REQUEST	Invalid program Id {programId}
53110	API_ANALYTICS	REQUEST	Cycle Id cannot be empty.
53115	API_ANALYTICS	REQUEST	Invalid cycle Id {cycleId}
53120	API_ANALYTICS	APPLICATION	Internal server error. Wait a few minutes and try the call again. If error persists contact the eBay Developer Program.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get a specific seller profile

This operation retrieves a specific seller profile.

Input

There is no call payload for this call. Supply the program and cycle for the profile you want to retrieve using path parameters in the operation's URI.

GEThttps://api.ebay.com/sell/analytics/v1/seller_standards_profile/PROGRAM_US/CURRENT

Output

A successful call returns the specified seller profile.

{
  "standardsLevel": "TOP_RATED",
  "program": "PROGRAM_US",
  "cycle": {
    "cycleType": "CURRENT",
    "evaluationDate": "2016-08-20T19:30:57.000Z",
    "evaluationMonth": "2016-08"
  },
  "evaluationReason": "Seller level generated by standards monthly evaluation cycle",
  "metrics": [
    {
      "metricKey": "MIN_DAYS_ON_SITE",
      "name": "Minimum days on site",
      "value": 703,
      "level": "TOP_RATED",
      "type": "NUMBER",
      "thresholdLowerBound": 90,
      "thresholdMetaData": "(UPPER,LOWER]"
    },
    {
      "metricKey": "MIN_TXN_COUNT",
      "name": "Transactions",
      "value": 720,
      "level": "TOP_RATED",
      "lookbackStartDate": "2015-08-01T07:00:00.000Z",
      "lookbackEndDate": "2016-07-31T07:00:00.000Z",
      "type": "NUMBER",
      "thresholdLowerBound": 100,
      "thresholdMetaData": "(UPPER,LOWER]"
    },
    {
      "metricKey": "MIN_GMV",
      "name": "Sales amount",
      "value": {
        "value": "41976.84",
        "currencyCodeEnum": "USD"
      },
      "level": "TOP_RATED",
      "lookbackStartDate": "2015-08-01T07:00:00.000Z",
      "lookbackEndDate": "2016-07-31T07:00:00.000Z",
      "type": "AMOUNT",
      "thresholdLowerBound": {
        "value": "1000.00"
      },
      "thresholdMetaData": "(UPPER,LOWER]"
    },
    {
      "metricKey": "DEFECTIVE_TRANSACTION_RATE",
      "name": "Transaction defect rate",
      "value": {
        "value": "0.14",
        "numerator": 1,
        "denominator": 720
      },
      "level": "TOP_RATED",
      "lookbackStartDate": "2015-08-01T07:00:00.000Z",
      "lookbackEndDate": "2016-07-31T07:00:00.000Z",
      "type": "RATE",
      "thresholdUpperBound": {
        "value": "0.50"
      },
      "thresholdMetaData": "(LOWER,UPPER]"
    },
    {
      "metricKey": "CLAIMS_SAF_RATE",
      "name": "Cases closed without seller resolution",
      "value": {
        "value": "0.00",
        "numerator": 0,
        "denominator": 720
      },
      "level": "TOP_RATED",
      "lookbackStartDate": "2015-08-01T07:00:00.000Z",
      "lookbackEndDate": "2016-07-31T07:00:00.000Z",
      "type": "RATE",
      "thresholdUpperBound": {
        "value": "0.30"
      },
      "thresholdMetaData": "(LOWER,UPPER]"
    },
    {
      "metricKey": "SHIPPING_MISS_RATE",
      "name": "Late shipment rate",
      "value": {
        "value": "0.91",
        "numerator": 3,
        "denominator": 329
      },
      "level": "TOP_RATED",
      "lookbackStartDate": "2015-09-12T07:00:00.000Z",
      "lookbackEndDate": "2016-07-31T07:00:00.000Z",
      "type": "RATE",
      "thresholdUpperBound": {
        "value": "3.00"
      },
      "thresholdMetaData": "(LOWER,UPPER]"
    },
    {
      "metricKey": "VALID_TRACKING_UPLOADED_WITHIN_HANDLING_RATE",
      "name": "Tracking uploaded on time and validated",
      "value": {
        "value": "99.07",
        "numerator": 107,
        "denominator": 108
      },
      "level": "TOP_RATED",
      "lookbackStartDate": "2016-05-01T07:00:00.000Z",
      "lookbackEndDate": "2016-07-31T07:00:00.000Z",
      "type": "RATE",
      "thresholdLowerBound": {
        "value": "90.00"
      },
      "thresholdMetaData": "(UPPER,LOWER]"
    }
  ],
  "defaultProgram": false
}