analytics API1.2.0

findSellerStandardsProfiles

GET
/seller_standards_profile
This call retrieves all the standards profiles 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's multiple profiles are 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 or at the time of the request.

Input

Resource URI (production)

GET https://api.ebay.com/sell/analytics/v1/seller_standards_profile

URI parameters

HTTP request headers

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

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.

Output

HTTP response headers

Output container/fieldTypeDescription
standardsProfilesarray of StandardsProfileA list of the seller's standards profiles.

A "standards profile" is a set of eBay seller standards categories and the values related to the associated seller.

Profiles are distinguished by a combination of cycle and program values. The "program" value specifies the region to which the data is from. The "cycle" value specifies whether the values were determined just now, or if the values are from the last official eBay seller standards evaluation.

Occurrence: Conditional

standardsProfiles.cycleCycleA 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

standardsProfiles.cycle.cycleTypeCycleTypeEnumThe 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

standardsProfiles.cycle.evaluationDatestringThe 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

standardsProfiles.cycle.evaluationMonthstringThe 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

standardsProfiles.defaultProgrambooleanIf 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

standardsProfiles.evaluationReasonstringSpecifies 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

standardsProfiles.metricsarray of MetricA 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

standardsProfiles.metrics.levelStandardsLevelEnumThe 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

standardsProfiles.metrics.lookbackEndDatestringThe end date and time, in ISO 8601 format, when the seller was evaluated for this metric.

Occurrence: Conditional

standardsProfiles.metrics.lookbackStartDatestringThe start date and time, in ISO 8601 format, when the seller was evaluated for this metric.

Occurrence: Conditional

standardsProfiles.metrics.metricKeystringAn internal key string specifying a metric. These are short, abbreviated, strings such as MIN_TXN_COUNT.

Occurrence: Conditional

standardsProfiles.metrics.namestringA 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

standardsProfiles.metrics.thresholdLowerBoundanySpecifies 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

standardsProfiles.metrics.thresholdMetaDatastringAn 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

standardsProfiles.metrics.thresholdUpperBoundanySpecifies 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 , 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

standardsProfiles.metrics.typeDataTypeEnumIndicates the data type of the returned metric. Possible values are: AMOUNT, BOOLEAN, DATE, FRACTION, NUMBER, and STRING.

Occurrence: Conditional

standardsProfiles.metrics.valueanyThe seller's calculated value, or score, for the metric.

Occurrence: Conditional

standardsProfiles.programProgramEnumIndicates the program used to generate the profile data. Values can be PROGRAM_DE, PROGRAM_UK, PROGRAM_US, or PROGRAM_GLOBAL.

Occurrence: Conditional

standardsProfiles.standardsLevelStandardsLevelEnumThe 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.

StatusMeaning
200Success
400Bad Request
500Internal Server Error

Error codes

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 all profiles for a seller

This operation retrieves all the profiles for a seller. With the possibility of four programs and two cycles, a seller can have a maximum of eight profiles total.

Input

There is no call payload for this call.
GET
https://api.sandbox.ebay.com/sell/analytics/v1/seller_standards_profile

Output

A successful call returns all existing profiles for the seller.