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
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
This method has no URI parameters.
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
Response fields
Output container/field | Type | Description |
---|---|---|
standardsProfiles | array of StandardsProfile | A list of the seller's standards profiles. Occurrence: Conditional |
standardsProfiles.cycle | Cycle | A complex type that specifies the profile's evaluation cycle ( Occurrence: Conditional |
standardsProfiles.cycle.cycleType | CycleTypeEnum | The cycle type, either Occurrence: Conditional |
standardsProfiles.cycle.evaluationDate | string | The date and time at which the standard compliance values were determined for the profile. Occurrence: Conditional |
standardsProfiles.cycle.evaluationMonth | string | The month in which the currently effective seller level was computed. Occurrence: Conditional |
standardsProfiles.defaultProgram | boolean | If set to Occurrence: Conditional |
standardsProfiles.evaluationReason | string | Specifies how the overall seller level was calculated. Occurrence: Conditional |
standardsProfiles.metrics | array of Metric | A list of the metrics upon which a seller's profile is evaluated. Occurrence: Conditional |
standardsProfiles.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 |
standardsProfiles.metrics.lookbackEndDate | string | The end date and time, in ISO 8601 format, when the seller was evaluated for this metric. Occurrence: Conditional |
standardsProfiles.metrics.lookbackStartDate | string | The start date and time, in ISO 8601 format, when the seller was evaluated for this metric. Occurrence: Conditional |
standardsProfiles.metrics.metricKey | string | An internal key string specifying a metric. These are short, abbreviated, strings such as Occurrence: Conditional |
standardsProfiles.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 |
standardsProfiles.metrics.thresholdLowerBound | any | Specifies the lowest number value can be and still qualify for the currently assigned seller level. Occurrence: Conditional |
standardsProfiles.metrics.thresholdMetaData | string | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries. Occurrence: Conditional |
standardsProfiles.metrics.thresholdUpperBound | any | Specifies the highest number value can be and still qualify for the currently assigned seller level. Occurrence: Conditional |
standardsProfiles.metrics.type | DataTypeEnum | Indicates the data type of the returned metric. Possible values are: AMOUNT, BOOLEAN, DATE, FRACTION, NUMBER, and STRING. Occurrence: Conditional |
standardsProfiles.metrics.value | any | The seller's calculated value, or score, for the metric. Occurrence: Conditional |
standardsProfiles.program | ProgramEnum | Indicates the program used to generate the profile data. Values can be Occurrence: Conditional |
standardsProfiles.standardsLevel | StandardsLevelEnum | The overall standards level of the seller, one of 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 |
400 | Bad Request |
500 | Internal Server Error |
Error codes
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 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.
GEThttps://api.sandbox.ebay.com/sell/analytics/v1/seller_standards_profile
Output
A successful call returns all existing profiles for the seller.