analytics API1.2.0

Metric

A complex type that defines a single metric which is evaluated as a part of a seller's standards profile.

For the specified metric, the metricKey value is its name and the level specifies how the seller is doing meeting eBay's standards for that metric (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD). The metric's value is the absolute number of the metric's value for the associated seller.

Type that uses Metric

Calls that use Metric

Fields

Field
Type
Description
level
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.
lookbackEndDate
The end date and time, in ISO 8601 format, when the seller was evaluated for this metric.
lookbackStartDate
The start date and time, in ISO 8601 format, when the seller was evaluated for this metric.
metricKey
An internal key string specifying a metric. These are short, abbreviated, strings such as MIN_TXN_COUNT.
name
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.
thresholdLowerBound
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.
thresholdMetaData
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.
thresholdUpperBound
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 , 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.
type
Indicates the data type of the returned metric. Possible values are: AMOUNT, BOOLEAN, DATE, FRACTION, NUMBER, and STRING.
value
The seller's calculated value, or score, for the metric.