Analytics API — client.sell.analytics¶
Version 1.3.2 · base path /sell/analytics/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_customer_service_metric ¶
get_customer_service_metric(customer_service_metric_type: str, evaluation_type: str, *, evaluation_marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_analytics_models.GetCustomerServiceMetricResponse
get_customer_service_metric(customer_service_metric_type: str, evaluation_type: str, *, evaluation_marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_customer_service_metric(customer_service_metric_type: str, evaluation_type: str, *, evaluation_marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_analytics_models.GetCustomerServiceMetricResponse | httpx.Response
Use this method to retrieve a seller's performance and rating for the customer service metric. Control the response from the getCustomerServiceMetric method using the following path and query parameters: customer_service_metric_type controls the type of customer service transactions evaluated for the metric rating. evaluation_type controls the period you want to review.
find_seller_standards_profiles ¶
find_seller_standards_profiles(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_analytics_models.FindSellerStandardsProfilesResponse
find_seller_standards_profiles(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
find_seller_standards_profiles(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_analytics_models.FindSellerStandardsProfilesResponse | httpx.Response
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 ).
get_seller_standards_profile ¶
get_seller_standards_profile(cycle: str, program: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_analytics_models.StandardsProfile
get_seller_standards_profile(cycle: str, program: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_seller_standards_profile(cycle: str, program: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_analytics_models.StandardsProfile | httpx.Response
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 ).
get_traffic_report ¶
get_traffic_report(*, dimension: str, filter: str, metric: str, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_analytics_models.Report
get_traffic_report(*, dimension: str, filter: str, metric: str, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_traffic_report(*, dimension: str, filter: str, metric: str, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_analytics_models.Report | httpx.Response
This method returns a report that details the user traffic received by a seller's listings. A traffic report gives sellers the ability to review how often their listings appeared on eBay, how many times their listings are viewed, and how many purchases were made. The report also returns the report's start and end dates, and the date the information was last updated.
Models¶
BenchmarkMetadata ¶
Bases: EbayModel
average
class-attribute
instance-attribute
¶
average = Field(None, description="This field returns the average value for the group, as defined by the specified basis . When the benchmark basis is set to PEER_BENCHMARK , the value returned in this field is the benchmark value to which the seller's metric value is compared to determine the seller's rating for the customer service metric.")
BenchmarkTypeEnum ¶
Bases: OpenStrEnum
CustomerServiceMetricTypeEnum ¶
CycleTypeEnum ¶
DimensionTypeEnum ¶
Distribution ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of a distribution in which the seller is active.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This field contains the number of transactions the seller had in the distribution (identified by the associated name field) during the metric evaluationCycle .')
ErrorParameter ¶
ErrorParameterV3 ¶
EvaluationTypeEnum ¶
MarketplaceIdEnum ¶
Bases: OpenStrEnum
MetricDistribution ¶
Bases: EbayModel
basis
class-attribute
instance-attribute
¶
basis = Field(None, description='This field returns the basis, or the method, by which the metric rating is calculated.')
data
class-attribute
instance-attribute
¶
data = Field(None, description='This field returns a list of name/value pairs, where the name indicates the distribution being rated and the value indicates the count of seller transactions that meet the distribution criteria.')
ProgramEnum ¶
Bases: OpenStrEnum
RangeValue ¶
Bases: EbayModel
end
class-attribute
instance-attribute
¶
end = Field(None, description='Specifies the end or upper limit of the range. This can be empty which equates to greater than or equal to the start or lower limit.')
exclusive_end
class-attribute
instance-attribute
¶
exclusive_end = Field(None, alias='exclusiveEnd', description="Specifies whether or not the end value is to be included in the range. For example, if end was 100, and exclusiveEnd is set to 'true', the end range is < 100. If it is set to 'false', the end range is <= 100.")
exclusive_start
class-attribute
instance-attribute
¶
exclusive_start = Field(None, alias='exclusiveStart', description="Specifies whether the start value is to be included in the range. For example, if start was 60, and exclusiveStart is set to 'true', the start range would be > 60. But if it is set to 'false', the start rage is >= 60.")
range
class-attribute
instance-attribute
¶
range = Field(None, description='If set to true , this flag indicates the filter covers a range of values.')
start
class-attribute
instance-attribute
¶
start = Field(None, description='Specifies the start or lower limit of the range. This can be empty which equates to lesser than or equal to the end or upper limit.')
RatingAdjustmentTypeEnum ¶
Bases: OpenStrEnum
RatingTypeEnum ¶
Bases: OpenStrEnum
SortField ¶
Bases: EbayModel
ascending
class-attribute
instance-attribute
¶
ascending = Field(None, description='If set to true , this flag indicates the results are sorted in ascending order.')
field
class-attribute
instance-attribute
¶
field = Field(None, description='Specifies the name of the metric on which the report is sorted. This indicated metric must be included in the metric parameter of the call. For example, sort=LISTING_IMPRESSION_TOTAL')
SrlDataTypeEnum ¶
SspDataTypeEnum ¶
Bases: OpenStrEnum
StandardsLevelEnum ¶
Value ¶
Bases: EbayModel
applicable
class-attribute
instance-attribute
¶
applicable = Field(None, description='If set to true , this flag indicates the value in the value field is valid as computed. A value of false indicates one or more of the values used to calculate the value was invalid. The occurrence of this is a rare, however consider this case: suppose a buyer navigates to a View Item page at 11:59 pm (the end of the day) and purchases the item at 12:05am the next day.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value of the report data.')
Cycle ¶
Bases: EbayModel
cycle_type
class-attribute
instance-attribute
¶
cycle_type = Field(None, alias='cycleType', description="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.")
evaluation_date
class-attribute
instance-attribute
¶
evaluation_date = Field(None, alias='evaluationDate', description='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')
evaluation_month
class-attribute
instance-attribute
¶
evaluation_month = Field(None, alias='evaluationMonth', description='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.')
Definition ¶
Bases: EbayModel
data_type
class-attribute
instance-attribute
¶
data_type = Field(None, alias='dataType', description='Indicates the data type of the returned dimension. For example, if the dimension is day , the data type is DATE .')
key
class-attribute
instance-attribute
¶
key = Field(None, description='The value the dimension or metric parameter as submitted in the request.')
localized_name
class-attribute
instance-attribute
¶
localized_name = Field(None, alias='localizedName', description='The localized name of the metric or dimension (translated into the language specified in the Accept-Language HTTP request header). For example, if Accept-Language is set to de-DE , the value "day" in the dimension container is returned as "tag", and a metric of TRANSACTION is returned as "Transaktionsanzahl".')
Dimension ¶
Bases: EbayModel
dimension_key
class-attribute
instance-attribute
¶
dimension_key = Field(None, alias='dimensionKey', description="This enum defines the basis against which the seller's customer service metric is measured. The value of this field gets set according to the value of the customer_service_metric_type input parameter.")
name
class-attribute
instance-attribute
¶
name = Field(None, description='The dimension name returned in this field depends on the dimensionKey : If dimensionKey is set to SHIPPING_REGION , this field is set to one of following values, which represent established shipping corridors: Domestic International: Mature region International: Emerging region If dimensionKey is set to LISTING_CATEGORY , this field is set to the name of the primary (L1) category in which the item…')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value returned in this field depends on the dimensionKey . If dimensionKey equals LISTING_CATEGORY , the value returned in this field is the category ID of the primary (L1) category in which the items being rated were listed. If dimensionKey equals SHIPPING_REGION , one of the following values is returned: DOMESTIC INTERNATIONAL_MATURED_REGION INTERNATIONAL_EMERGING_REGION')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
ErrorDetailV3 ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies whether the error was in the REQUEST or happened when running the APPLICATION.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='The primary system where the error occurred. This is relevant for application errors. For Analytics errors, it always has the value API_ANALYTICS .')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Traffic report error IDs range from 50001 to 50500.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description="Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.")
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error than given in the message error field.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId .')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value .')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='If present, indicates which subsystem in which the error occurred.')
EvaluationCycle ¶
Bases: EbayModel
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='End date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST). The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.')
evaluation_date
class-attribute
instance-attribute
¶
evaluation_date = Field(None, alias='evaluationDate', description='The ISO-8601 date and time at which the seller was evaluated for this customer service metric rating.')
evaluation_type
class-attribute
instance-attribute
¶
evaluation_type = Field(None, alias='evaluationType', description='This field specifies the transaction lookback period used for the evaluation. The evaluation_type value specified in the request is returned in this field. There are two possible values: CURRENT – A monthly evaluation that occurs on the 20th of every month.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The start date and time of the transaction lookback range. All timestamps are based on Mountain Standard Time (MST). The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2018-08-04T07:09:00.000Z')
FilterField ¶
Bases: EbayModel
field
class-attribute
instance-attribute
¶
field = Field(None, description='Note: This filter is not currently supported.')
negated
class-attribute
instance-attribute
¶
negated = Field(None, description='Note: This filter is not currently supported.')
range
class-attribute
instance-attribute
¶
range = Field(None, description='Note: This filter is not currently supported.')
set
class-attribute
instance-attribute
¶
set = Field(None, description='Note: This filter is not currently supported.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='Provides a way to filter the results based on a value. Valid values: date_range marketplace_ids listing_ids')
Header ¶
Bases: EbayModel
dimension_keys
class-attribute
instance-attribute
¶
dimension_keys = Field(None, alias='dimensionKeys', description='A list of the dimension or metric keys returned in the report. The values for each are is returned in the associated key fields.')
metrics
class-attribute
instance-attribute
¶
metrics = Field(None, description='The list of metrics returned in the report. The values for each are is returned in the associated key fields.')
MetadataHeader ¶
Bases: EbayModel
key
class-attribute
instance-attribute
¶
key = Field(None, description='The key value used for the report. For example: "key": "LISTING_ID"')
metadata_keys
class-attribute
instance-attribute
¶
metadata_keys = Field(None, alias='metadataKeys', description='The list of dimension key values used for the report header. Each list element contains the key name, its data type, and its localized name. For example: "metadataKeys": [ "key": "LISTING_TITLE", "localizedName": "Listing title", "dataType": "STRING"')
MetadataRecord ¶
Bases: EbayModel
metadata_values
class-attribute
instance-attribute
¶
metadata_values = Field(None, alias='metadataValues', description='A list of data in a row returned in the traffic report. The data in each of the cells match the labels in headers of the report.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value of the key on which the report is based. For example, if the key is the listing ID, the value of this container could be: "value": { "value": "142133954229", "applicable": true }')
MetricBenchmark ¶
Bases: EbayModel
adjustment
class-attribute
instance-attribute
¶
adjustment = Field(None, description='If this field is present, it indicates that the rating given to the seller was "adjusted" for one reason or another. If eBay determines that the normal rating of a seller is impacted by circumstances beyond their control, they can issue an override to adjust the rating given to the seller.')
basis
class-attribute
instance-attribute
¶
basis = Field(None, description='This field returns the "basis" by which the benchmark is calculated for the customer service metric type. Currently, the only supported basis is PEER_BENCHMARK .')
metadata
class-attribute
instance-attribute
¶
metadata = Field(None, description='This field contains the benchmark data.')
rating
class-attribute
instance-attribute
¶
rating = Field(None, description="This field returns seller's rating for the customer service metric. The rating is set to a value that equals the relative deviation between the seller's metric value and the benchmark value for the customer service metric. Deviation values range from LOW to VERY HIGH , and the lower the deviation, the better the seller rating.")
Record ¶
Bases: EbayModel
dimension_values
class-attribute
instance-attribute
¶
dimension_values = Field(None, alias='dimensionValues', description="A list where each element contains either the string DAY (if the dimension is DAY ), or the listing ID for which the record's metric data is computed. A second array member, applicable , is always true for dimension values.")
metric_values
class-attribute
instance-attribute
¶
metric_values = Field(None, alias='metricValues', description="A list where each element contains a value field that indicates the record's value for the metric. Each element also contains an applicable field that indicates the veracity of the computed value . Note that there are no metric names or IDs associated with the values returned in this array. The metadata to which these values relate can be found in the key values in metadataKeys .")
SspMetric ¶
Bases: EbayModel
level
class-attribute
instance-attribute
¶
level = Field(None, description="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 .")
lookback_end_date
class-attribute
instance-attribute
¶
lookback_end_date = Field(None, alias='lookbackEndDate', description='The end date and time, in ISO 8601 format, when the seller was evaluated for this metric.')
lookback_start_date
class-attribute
instance-attribute
¶
lookback_start_date = Field(None, alias='lookbackStartDate', description='The start date and time, in ISO 8601 format, when the seller was evaluated for this metric.')
metric_key
class-attribute
instance-attribute
¶
metric_key = Field(None, alias='metricKey', description='An internal key string specifying a metric. These are short, abbreviated, strings such as MIN_TXN_COUNT .')
name
class-attribute
instance-attribute
¶
name = Field(None, description='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.')
threshold_lower_bound
class-attribute
instance-attribute
¶
threshold_lower_bound = Field(None, alias='thresholdLowerBound', description='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 .')
threshold_meta_data
class-attribute
instance-attribute
¶
threshold_meta_data = Field(None, alias='thresholdMetaData', description="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 ).")
threshold_upper_bound
class-attribute
instance-attribute
¶
threshold_upper_bound = Field(None, alias='thresholdUpperBound', description='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 .')
type
class-attribute
instance-attribute
¶
type = Field(None, description='Indicates the data type of the returned metric. Possible values are: AMOUNT , BOOLEAN , DATE , FRACTION , NUMBER , and STRING .')
value
class-attribute
instance-attribute
¶
value = Field(None, description="The seller's calculated value, or score, for the metric. Note: Depending on the metric being returned, this field can be returned as an Integer, Boolean, Fraction, or Amount.")
StandardsProfile ¶
Bases: EbayModel
cycle
class-attribute
instance-attribute
¶
cycle = Field(None, description="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.")
default_program
class-attribute
instance-attribute
¶
default_program = Field(None, alias='defaultProgram', description="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.")
evaluation_reason
class-attribute
instance-attribute
¶
evaluation_reason = Field(None, alias='evaluationReason', description='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."')
metrics
class-attribute
instance-attribute
¶
metrics = Field(None, description="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 .")
program
class-attribute
instance-attribute
¶
program = Field(None, description='Indicates the program used to generate the profile data. Values can be PROGRAM_DE , PROGRAM_UK , PROGRAM_US , or PROGRAM_GLOBAL .')
standards_level
class-attribute
instance-attribute
¶
standards_level = Field(None, alias='standardsLevel', description='The overall standards level of the seller, one of TOP_RATED , ABOVE_STANDARD , or BELOW_STANDARD .')
ApiMetric ¶
Bases: EbayModel
benchmark
class-attribute
instance-attribute
¶
benchmark = Field(None, description="This complex type defines a set of benchmark data, which includes the average rating for the group included in the benchmark evaluation and the seller's calculated customer service metric rating for the benchmark. This container is returned only if the associated metricKey value is RATE .")
distributions
class-attribute
instance-attribute
¶
distributions = Field(None, description='Returned when metricKey equals COUNT , this field returns an array of seller data where each set of data is grouped according by an overarching basis .')
metric_key
class-attribute
instance-attribute
¶
metric_key = Field(None, alias='metricKey', description='This field indicates the customer service metric being returned in the associated metrics container. The field is set as follows: TRANSACTION_COUNT – When set to this value, the associated value field returns the number of transactions completed in the peer group for the metric being evaluated in the associated dimension and evaluationCycle .')
value
class-attribute
instance-attribute
¶
value = Field(None, description="This field is set to the seller's numeric rating for the associated metricKey for the given dimension during the evaluationCycle . To determine the seller's rating for this metric, the value of this field is compared to the average metric value of the group.")
DimensionMetric ¶
Bases: EbayModel
dimension
class-attribute
instance-attribute
¶
dimension = Field(None, description='This type defines the "dimension," or attributes, against which the associated customer service metric values and benchmark ratings are based. The dimensionKey value is set according to the customer_service_metric_type request parameter and the values in the associated name / value pairs relate to the dimensionKey that\'s being used to calculate the benchmark rating.')
metrics
class-attribute
instance-attribute
¶
metrics = Field(None, description='This is a list of Metric elements where each element contains data and information related to the transactions grouped by the associated dimension .')
FindSellerStandardsProfilesResponse ¶
Bases: EbayModel
standards_profiles
class-attribute
instance-attribute
¶
standards_profiles = Field(None, alias='standardsProfiles', description='A 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.')
GetCustomerServiceMetricResponse ¶
Bases: EbayModel
dimension_metrics
class-attribute
instance-attribute
¶
dimension_metrics = Field(None, alias='dimensionMetrics', description="This container provides a seller's customer service metric performance for a given dimension . In the getCustomerServiceMetric request, specify values for the following request parameters to control the returned dimension and the associated metric values: customer_service_metric_type evaluation_type evaluation_marketplace_id")
evaluation_cycle
class-attribute
instance-attribute
¶
evaluation_cycle = Field(None, alias='evaluationCycle', description="This complex type defines the evaluation type ( CURRENT or PROJECTED ) and the transaction lookback period used to calculate the seller's customer service metric.")
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. The customer_service_metric resource supports a limited set of marketplaces. For a complete list of the supported marketplaces, please see the Service metrics policy page.')
Metadata ¶
Bases: EbayModel
metadata_header
class-attribute
instance-attribute
¶
metadata_header = Field(None, alias='metadataHeader', description='The container that returns the dimensionKeys and metrics headers for the report.')
metadata_records
class-attribute
instance-attribute
¶
metadata_records = Field(None, alias='metadataRecords', description='A list of the individual report records.')
Report ¶
Bases: EbayModel
dimension_metadata
class-attribute
instance-attribute
¶
dimension_metadata = Field(None, alias='dimensionMetadata', description='A complex type containing the header of the report and the type of data containted in the rows of the report.')
end_date
class-attribute
instance-attribute
¶
end_date = Field(None, alias='endDate', description='The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock. If you specify an end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the lastUpdateDate date. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2018-08-20T07:09:00.000Z')
header
class-attribute
instance-attribute
¶
header = Field(None, description='A complex type containing the header for the report.')
last_updated_date
class-attribute
instance-attribute
¶
last_updated_date = Field(None, alias='lastUpdatedDate', description='The date and time, in ISO 8601 format, that indicates the last time the data returned in the report was updated.')
records
class-attribute
instance-attribute
¶
records = Field(None, description='A complex type containing the individual data records for the traffic report.')
start_date
class-attribute
instance-attribute
¶
start_date = Field(None, alias='startDate', description='The start date of the date range used to calculate the report, in ISO 8601 format.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of any process errors or warnings that were generated during the processing of the call processing.')