eBay Analytics Connector Objects
Name | Description |
---|---|
CustomerServiceMetricByCategory | Returns a seller's performance and rating for the customer service metric by the primary proudct categories. |
CustomerServiceMetricByShippingRegion | Returns a seller's performance and rating for the customer service metric by the established shipping corridors. |
SellerStandardsProfile | Returns the standards profiles for the associated seller. |
TrafficReportByDay | Returns a report that details the user traffic received by a seller's listings per day. |
TrafficReportByListing | Returns a report that details the user traffic received by a seller's listings per listing. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CategoryId | String | False | No | The primary category ID in which the items being rated were listed. | |
CategoryName | String | False | No | The primary category name in which the items being rated were listed. | |
TransactionCount | Integer | False | No | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. | |
Count | Integer | False | No | The total number of transactions the seller completed that meet the criteria of the MetricType for the given dimension that occurred during the evaluationCycle. | |
DistributionsBasis | String | False | No | The overarching basis by which an array of seller data is grouped. Along with DistributionsData, they expand the total number of transactions in Count column grouped by a certain basis. | |
DistributionsData | String | False | No | Expands the Count column data via an aggregated 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. | |
Rate | Double | False | No | The rate of the customer service MetricType in the given dimension during the associated evaluationCycle. Specifically, it is the TransactionCount divided by the Count value. | |
BenchmarkBasis | String | False | No | The basis by which the benchmark is calculated for the MetricType. | |
BenchmarkRating | String | False | No | The seller's rating for the ServiceMetric. It represents the relative deviation between the seller's Rate metric value and the benchmark value for the specified ServiceMetric. | |
BenchmarkAverage | Double | False | No | The average value for the group, as defined by the specified BenchmarkBasis. When BenchmarkBasis is 'PEER_BENCHMARK', this is the benchmark value to which the seller's metric value is compared to determine the BenchmarkRating for the ServiceMetric. | |
BenchmarkAdjustment | String | False | No | The reason why the rating given to the seller was adjusted. | |
EvaluationDate | Datetime | False | No | Date and time at which the seller was evaluated for this customer service metric rating. | |
EvaluationType | String | False | No | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. | |
StartDate | Datetime | False | No | The start date and time of the transaction lookback range. | |
EndDate | Datetime | False | No | End date and time of the transaction lookback range. | |
MarketplaceId | String | False | No | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. | |
MetricType | String | False | No | The type of customer service metric. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ShippingRegionId | String | False | No | The Id of the established shipping corridor. | |
ShippingRegionName | String | False | No | The Name of the established shipping corridor. | |
TransactionCount | Integer | False | No | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. | |
Count | Integer | False | No | The total number of transactions the seller completed that meet the criteria of the MetricType for the given dimension that occurred during the evaluationCycle. | |
DistributionsBasis | String | False | No | The overarching basis by which an array of seller data is grouped. Along with DistributionsData, they expand the total number of transactions in Count column grouped by a certain basis. | |
DistributionsData | String | False | No | Expands the Count column data via an aggregated 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. | |
Rate | Double | False | No | The rate of the customer service MetricType in the given dimension during the associated evaluationCycle. Specifically, it is the TransactionCount divided by the Count value. | |
BenchmarkBasis | String | False | No | The basis by which the benchmark is calculated for the MetricType. | |
BenchmarkRating | String | False | No | The seller's rating for the ServiceMetric. It represents the relative deviation between the seller's Rate metric value and the benchmark value for the specified ServiceMetric. | |
BenchmarkAverage | Double | False | No | The average value for the group, as defined by the specified BenchmarkBasis. When BenchmarkBasis is 'PEER_BENCHMARK', this is the benchmark value to which the seller's metric value is compared to determine the BenchmarkRating for the ServiceMetric. | |
BenchmarkAdjustment | String | False | No | The reason why the rating given to the seller was adjusted. | |
EvaluationDate | Datetime | False | No | Date and time at which the seller was evaluated for this customer service metric rating. | |
EvaluationType | String | False | No | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. | |
StartDate | Datetime | False | No | The start date and time of the transaction lookback range. | |
EndDate | Datetime | False | No | End date and time of the transaction lookback range. | |
MarketplaceId | String | False | No | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. | |
MetricType | String | False | No | The type of customer service metric. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Program | String | False | No | The program used to generate the profile data. Values can be PROGRAM_DE, PROGRAM_UK, PROGRAM_US, or PROGRAM_GLOBAL. | |
DefaultProgram | Boolean | False | No | Boolean indicating if this is the default program for the seller. | |
StandardsLevel | String | False | No | The overall standards level of the seller, one of TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD. | |
EvaluationReason | String | False | No | Specifies how the overall seller level was calculated. | |
Cycle | String | False | No | 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. | |
EvaluationDate | Datetime | False | No | The date and time at which the standard compliance values were determined for the profile. | |
EvaluationMonth | String | False | No | 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. | |
MinimumDaysOnSite | Integer | False | No | Minimum days on site. | |
Transactions | Integer | False | No | The total Transactions count. | |
SalesAmount | Decimal | False | No | The total Sales amount. | |
TransactionDefectRate | Decimal | False | No | Transaction defect rate. | |
CasesClosedWithoutSellerResolution | Decimal | False | No | Total cases closed without seller resolution. | |
LateShipmentRate | Decimal | False | No | Late shipment rate. | |
TrackingUploadedOnTimeAndValidated | Decimal | False | No | Tracking uploaded on time and validated. | |
BusinessSeller | Boolean | False | No | Business seller critera met. | |
PowerSeller | Boolean | False | No | Power seller criteria met. | |
MinimumDaysOnSiteLevel | String | False | No | The seller level for the MinimumDaysOnSite 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. | |
TransactionsLevel | String | False | No | The seller level for the Transactions 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. | |
SalesAmountLevel | String | False | No | The seller level for the SalesAmount 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. | |
TransactionDefectRateLevel | String | False | No | The seller level for the TransactionDefectRate 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. | |
CasesClosedWithoutSellerResolutionLevel | String | False | No | The seller level for the CasesClosedWithoutSellerResolution 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. | |
LateShipmentRateLevel | String | False | No | The seller level for the LateShipmentRate 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. | |
TrackingUploadedOnTimeAndValidatedLevel | String | False | No | The seller level for the TrackingUploadedOnTimeAndValidated 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. | |
BusinessSellerLevel | String | False | No | The seller level for the BusinessSeller 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. | |
PowerSellerLevel | String | False | No | The seller level for the PowerSeller 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. | |
MinimumDaysOnSiteThresholdLowerBound | Integer | False | No | Specifies the lowest number value for the MinimumDaysOnSite metric can be and still qualify for the currently assigned seller level. | |
TransactionsThresholdLowerBound | Integer | False | No | Specifies the lowest number value for the Transactions metric can be and still qualify for the currently assigned seller level. | |
SalesAmountThresholdLowerBound | Decimal | False | No | Specifies the lowest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. | |
TrackingUploadedOnTimeAndValidatedThresholdLowerBound | Decimal | False | No | Specifies the lowest number value for the TrackingUploadedOnTimeAndValidated metric can be and still qualify for the currently assigned seller level. | |
BusinessSellerThresholdLowerBound | Boolean | False | No | Specifies the lowest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. | |
PowerSellerThresholdLowerBound | Boolean | False | No | Specifies the lowest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. | |
TransactionsThresholdUpperBound | Integer | False | No | Specifies the highest number value for the Transactions metric can be and still qualify for the currently assigned seller level. | |
SalesAmountThresholdUpperBound | Decimal | False | No | Specifies the highest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. | |
TransactionDefectRateThresholdUpperBound | Decimal | False | No | Specifies the highest number value for the TransactionDefectRate metric can be and still qualify for the currently assigned seller level. | |
CasesClosedWithoutSellerResolutionThresholdUpperBound | Decimal | False | No | Specifies the highest number value for the CasesClosedWithoutSellerResolution metric can be and still qualify for the currently assigned seller level. | |
LateShipmentRateThresholdUpperBound | Decimal | False | No | Specifies the highest number value for the LateShipmentRate metric can be and still qualify for the currently assigned seller level. | |
BusinessSellerThresholdUpperBound | Boolean | False | No | Specifies the highest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. | |
PowerSellerThresholdUpperBound | Boolean | False | No | Specifies the highest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. | |
MinimumDaysOnSiteThresholdMetaData | String | False | No | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the MinimumDaysOnSite metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. | |
TransactionsThresholdMetaData | String | False | No | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the Transactions metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. | |
SalesAmountThresholdMetaData | String | False | No | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the SalesAmount metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. | |
TransactionDefectRateThresholdMetaData | String | False | No | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the TransactionDefectRate metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. | |
CasesClosedWithoutSellerResolutionThresholdMetaData | String | False | No | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the CasesClosedWithoutSellerResolution metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. | |
LateShipmentRateThresholdMetaData | String | False | No | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the LateShipmentRate metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. | |
TrackingUploadedOnTimeAndValidatedThresholdMetaData | String | False | No | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the TrackingUploadedOnTimeAndValidated metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. | |
TransactionsLookbackStartDate | Datetime | False | No | The start date and time when the seller was evaluated for the Transactions metric. | |
SalesAmountLookbackStartDate | Datetime | False | No | The start date and time when the seller was evaluated for the SalesAmount metric. | |
TransactionDefectRateLookbackStartDate | Datetime | False | No | The start date and time when the seller was evaluated for the TransactionDefectRate metric. | |
CasesClosedWithoutSellerResolutionLookbackStartDate | Datetime | False | No | The start date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. | |
LateShipmentRateLookbackStartDate | Datetime | False | No | The start date and time when the seller was evaluated for the LateShipmentRate metric. | |
TrackingUploadedOnTimeAndValidatedLookbackStartDate | Datetime | False | No | The start date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. | |
TransactionsLookbackEndDate | Datetime | False | No | The end date and time when the seller was evaluated for the Transactions metric. | |
SalesAmountLookbackEndDate | Datetime | False | No | The end date and time when the seller was evaluated for the SalesAmount metric. | |
TransactionDefectRateLookbackEndDate | Datetime | False | No | The end date and time when the seller was evaluated for the TransactionDefectRate metric. | |
CasesClosedWithoutSellerResolutionLookbackEndDate | Datetime | False | No | The end date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. | |
LateShipmentRateLookbackEndDate | Datetime | False | No | The end date and time when the seller was evaluated for the LateShipmentRate metric. | |
TrackingUploadedOnTimeAndValidatedLookbackEndDate | Datetime | False | No | The end date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. | |
SalesAmountCurrency | String | False | No | The sales amount currency. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Day | Date | False | No | The Day (individual date) by which the metrics are grouped. | |
ClickThroughRate | Double | False | No | The number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page. | |
ListingImpressionSearchResultsPage | Integer | False | No | The number of times the seller's listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page. | |
ListingImpressionStore | Integer | False | No | The number of times the seller's listings displayed on the seller's store. Note, the listing might not have been visible to the buyer due to its position on the page. | |
ListingImpressionTotal | Integer | False | No | The total number of times the seller's listings displayed on the search results page OR in the seller's store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. This is a combination of: ListingImpressionSearchResultsPage + ListingImpressionStore. | |
ListingViewsSourceDirect | Integer | False | No | The number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark. | |
ListingViewsSourceOffEbay | Integer | False | No | The number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page. | |
ListingViewsSourceOtherEbay | Integer | False | No | The number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller's store. | |
ListingViewsSourceSearchResultsPage | Integer | False | No | The number of times the item displayed on the search results page. | |
ListingViewsSourceStore | Integer | False | No | The number of times a View Item page was accessed via the seller's store. | |
ListingViewsTotal | Integer | False | No | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. | |
SalesConversionRate | Double | False | No | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. | |
TotalImpressionTotal | Integer | False | No | The total number of times the seller's listings have displayed on any page or flow. It matches the value on the Seller Hub performance/traffic page. It includes the impressions from the ListingImpressionTotal metric plus any other impressions including those listings that display on pages other than search result and store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. | |
TransactionsCount | Integer | False | No | The total number of completed transactions. | |
UsageStartDate | Datetime | False | No | The start date of the actual date range of the report data. | |
UsageEndDate | Datetime | False | No | The end date of the actual date range of the report data. | |
LastUpdatedDate | Datetime | False | No | The last time the data returned in the report was updated. | |
ReportStartDate | Date | False | No | The requested start date of the date range used to calculate the report. | |
ReportEndDate | Date | False | No | The requested end date of the date range used to calculate the report. If you specify an report end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the LastUpdateDate. For this reason, the provided ReportStartDate and ReportEndDate values used to request the report might not match with the report's actual date range: ReportStartDate - ReportEndDate. | |
MarketplaceId | String | False | Yes | The eBay marketplace ID of the marketplace upon which the seller report is limited. | |
ListingId | String | False | Yes | The Id of the Listing by which the metrics are grouped. You can get your ListingId-s from the TrafficReportByListing view. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ListingId | String | False | No | The Id of the Listing by which the metrics are grouped. | |
ListingName | String | False | No | The Listing Name. | |
ClickThroughRate | Double | False | No | The number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page. | |
ListingImpressionSearchResultsPage | Integer | False | No | The number of times the seller's listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page. | |
ListingImpressionStore | Integer | False | No | The number of times the seller's listings displayed on the seller's store. Note, the listing might not have been visible to the buyer due to its position on the page. | |
ListingImpressionTotal | Integer | False | No | The total number of times the seller's listings displayed on the search results page OR in the seller's store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. This is a combination of: ListingImpressionSearchResultsPage + ListingImpressionStore. | |
ListingViewsSourceDirect | Integer | False | No | The number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark. | |
ListingViewsSourceOffEbay | Integer | False | No | The number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page. | |
ListingViewsSourceOtherEbay | Integer | False | No | The number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller's store. | |
ListingViewsSourceSearchResultsPage | Integer | False | No | The number of times the item displayed on the search results page. | |
ListingViewsSourceStore | Integer | False | No | The number of times a View Item page was accessed via the seller's store. | |
ListingViewsTotal | Integer | False | No | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. | |
SalesConversionRate | Double | False | No | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. | |
TotalImpressionTotal | Integer | False | No | The total number of times the seller's listings have displayed on any page or flow. It matches the value on the Seller Hub performance/traffic page. It includes the impressions from the ListingImpressionTotal metric plus any other impressions including those listings that display on pages other than search result and store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. | |
TransactionsCount | Integer | False | No | The total number of completed transactions. | |
UsageStartDate | Datetime | False | No | The start date of the actual date range of the report data. | |
UsageEndDate | Datetime | False | No | The end date of the actual date range of the report data. | |
LastUpdatedDate | Datetime | False | No | The last time the data returned in the report was updated. | |
ReportStartDate | Date | False | No | The requested start date of the date range used to calculate the report. | |
ReportEndDate | Date | False | No | The requested end date of the date range used to calculate the report. If you specify an report end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the LastUpdateDate. For this reason, the provided ReportStartDate and ReportEndDate values used to request the report might not match with the report's actual date range: ReportStartDate - ReportEndDate. | |
MarketplaceId | String | False | Yes | The eBay marketplace ID of the marketplace upon which the seller report is limited. |