CData Cloud offers access to eBay Analytics across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to eBay Analytics through CData Cloud.
CData Cloud allows you to standardize and configure connections to eBay Analytics as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to eBay Analytics in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to eBay Analytics and configure any necessary connection properties to create a database in CData Cloud
Accessing data from eBay Analytics through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to eBay Analytics by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
You can establish a connection and authenticate to the eBay Analytics only via the OAuth 2 authentication method. The eBay Analytics API requires an access token created with the authorization code grant flow to authorize the requests.
eBay Analytics supports the OAuth 2.0 Authentication method. To perform this authentication, you need to first join the eBay Developers Program.
You can follow the procedure below to obtain the OAuth client credentials, the OAuthClientId, OAuthClientSecret and the RuName.
Note that eBay Analytics requires a secure Redirect URI (https). For Desktop applications you can set this to https://oauth.cdata.com/oauth/ and optionally, the CallbackURL connection property to a local Redirect URL (for example, http://localhost:33333).
After following these steps, save the OAuthClientId, OAuthClientSecret and RuName with the configured CallbackURL.
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API resources and provides more information on executing SQL to eBay Analytics APIs.
Views describes the available views. Views are statically defined to model CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, SellerStandardsProfile, TrafficReportByDay and TrafficReportByListing.
Stored Procedures are function-like interfaces to eBay Analytics. Stored procedures allow you to execute operations to eBay Analytics. The eBay Analytics supports only stored procedures related to authentication.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| 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. |
Returns a seller's performance and rating for the customer service metric by the primary proudct categories.
The Cloud will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
To query the CustomerServiceMetricByCategory view, a value for the EvaluationType and MarketplaceId columns should be specified.
The MarketplaceId is server side filterable and supports only the operator: =.
Supported MarketplaceId values are: EBAY_AU, EBAY_CA, EBAY_FR, EBAY_DE, EBAY_GB, EBAY_IT, EBAY_ES and EBAY_US.
The EvaluationType is server side filterable and supports only the operator: =.
Supported EvaluationType values are: CURRENT and PROJECTED.
The example query below will return CustomerServiceMetricByCategory data for the CURRENT Evaluation Type period and for the Marketplace specified in the MarketplaceId connection property.
SELECT * FROM CustomerServiceMetricByCategory
The example query below will return CustomerServiceMetricByCategory data for the PROJECTED Evaluation Type period and for the US Marketplace.
SELECT * FROM CustomerServiceMetricByCategory WHERE EvaluationType = 'PROJECTED' AND MarketplaceId = 'EBAY_US'
Note: Querying this view will return results only if the below conditions are met.
| Name | Type | Description |
| CategoryId | String | The primary category ID in which the items being rated were listed. |
| CategoryName | String | The primary category name in which the items being rated were listed. |
| TransactionCount | Integer | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. |
| Count | Integer | 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 | 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 | 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 | 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 | The basis by which the benchmark is calculated for the MetricType. |
| BenchmarkRating | String | 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 | 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 | The reason why the rating given to the seller was adjusted. |
| EvaluationDate | Datetime | Date and time at which the seller was evaluated for this customer service metric rating. |
| EvaluationType | String | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. |
| StartDate | Datetime | The start date and time of the transaction lookback range. |
| EndDate | Datetime | End date and time of the transaction lookback range. |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. |
| MetricType | String | The type of customer service metric. |
Returns a seller's performance and rating for the customer service metric by the established shipping corridors.
The Cloud will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
To query the CustomerServiceMetricByShippingRegion view, a value for the EvaluationType and MarketplaceId columns should be specified.
The MarketplaceId is server side filterable and supports only the operator: =.
Supported MarketplaceId values are: EBAY_AU, EBAY_CA, EBAY_FR, EBAY_DE, EBAY_GB, EBAY_IT, EBAY_ES and EBAY_US.
The EvaluationType is server side filterable and supports only the operator: =.
Supported EvaluationType values are: CURRENT and PROJECTED.
The example query below will return CustomerServiceMetricByShippingRegion data for the CURRENT Evaluation Type period and for the Marketplace specified in the MarketplaceId connection property.
SELECT * FROM CustomerServiceMetricByShippingRegion
The example query below will return CustomerServiceMetricByShippingRegion data for the PROJECTED Evaluation Type period and for the German Marketplace.
SELECT * FROM CustomerServiceMetricByShippingRegion WHERE EvaluationType = 'PROJECTED' AND MarketplaceId = 'EBAY_DE'
Note: Querying this view will return results only if the below conditions are met.
| Name | Type | Description |
| ShippingRegionId | String | The Id of the established shipping corridor. |
| ShippingRegionName | String | The Name of the established shipping corridor. |
| TransactionCount | Integer | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. |
| Count | Integer | 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 | 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 | 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 | 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 | The basis by which the benchmark is calculated for the MetricType. |
| BenchmarkRating | String | 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 | 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 | The reason why the rating given to the seller was adjusted. |
| EvaluationDate | Datetime | Date and time at which the seller was evaluated for this customer service metric rating. |
| EvaluationType | String | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. |
| StartDate | Datetime | The start date and time of the transaction lookback range. |
| EndDate | Datetime | End date and time of the transaction lookback range. |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. |
| MetricType | String | The type of customer service metric. |
Returns the standards profiles for the associated seller.
The Cloud will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
The Program and Cycle columns support server side filtering only when specified at the same time and only for the = operator.
For example, the query below is processed server side and it returns the SellerStandardsProfile report data for the Current cycle based on the US Program standards.
SELECT * FROM SellerStandardsProfile WHERE Cycle = 'CURRENT' AND Program = 'PROGRAM_US'
The other example query below, will return the SellerStandardsProfile for every available program standards region and for both cycles, Current and PROJECTED.
SELECT * FROM SellerStandardsProfile
| Name | Type | Description |
| Program | String | The program used to generate the profile data. Values can be PROGRAM_DE, PROGRAM_UK, PROGRAM_US, or PROGRAM_GLOBAL. |
| DefaultProgram | Boolean | Boolean indicating if this is the default program for the seller. |
| StandardsLevel | String | The overall standards level of the seller, one of TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD. |
| EvaluationReason | String | Specifies how the overall seller level was calculated. |
| Cycle | String | 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 | The date and time at which the standard compliance values were determined for the profile. |
| EvaluationMonth | String | 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 | Minimum days on site. |
| Transactions | Integer | The total Transactions count. |
| SalesAmount | Decimal | The total Sales amount. |
| TransactionDefectRate | Decimal | Transaction defect rate. |
| CasesClosedWithoutSellerResolution | Decimal | Total cases closed without seller resolution. |
| LateShipmentRate | Decimal | Late shipment rate. |
| TrackingUploadedOnTimeAndValidated | Decimal | Tracking uploaded on time and validated. |
| BusinessSeller | Boolean | Business seller critera met. |
| PowerSeller | Boolean | Power seller criteria met. |
| MinimumDaysOnSiteLevel | String | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | Specifies the lowest number value for the MinimumDaysOnSite metric can be and still qualify for the currently assigned seller level. |
| TransactionsThresholdLowerBound | Integer | Specifies the lowest number value for the Transactions metric can be and still qualify for the currently assigned seller level. |
| SalesAmountThresholdLowerBound | Decimal | Specifies the lowest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. |
| TrackingUploadedOnTimeAndValidatedThresholdLowerBound | Decimal | Specifies the lowest number value for the TrackingUploadedOnTimeAndValidated metric can be and still qualify for the currently assigned seller level. |
| BusinessSellerThresholdLowerBound | Boolean | Specifies the lowest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. |
| PowerSellerThresholdLowerBound | Boolean | Specifies the lowest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. |
| TransactionsThresholdUpperBound | Integer | Specifies the highest number value for the Transactions metric can be and still qualify for the currently assigned seller level. |
| SalesAmountThresholdUpperBound | Decimal | Specifies the highest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. |
| TransactionDefectRateThresholdUpperBound | Decimal | Specifies the highest number value for the TransactionDefectRate metric can be and still qualify for the currently assigned seller level. |
| CasesClosedWithoutSellerResolutionThresholdUpperBound | Decimal | Specifies the highest number value for the CasesClosedWithoutSellerResolution metric can be and still qualify for the currently assigned seller level. |
| LateShipmentRateThresholdUpperBound | Decimal | Specifies the highest number value for the LateShipmentRate metric can be and still qualify for the currently assigned seller level. |
| BusinessSellerThresholdUpperBound | Boolean | Specifies the highest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. |
| PowerSellerThresholdUpperBound | Boolean | Specifies the highest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. |
| MinimumDaysOnSiteThresholdMetaData | String | 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 | 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 | 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 | 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 | 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 | 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 | 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 | The start date and time when the seller was evaluated for the Transactions metric. |
| SalesAmountLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the SalesAmount metric. |
| TransactionDefectRateLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the TransactionDefectRate metric. |
| CasesClosedWithoutSellerResolutionLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. |
| LateShipmentRateLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the LateShipmentRate metric. |
| TrackingUploadedOnTimeAndValidatedLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. |
| TransactionsLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the Transactions metric. |
| SalesAmountLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the SalesAmount metric. |
| TransactionDefectRateLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the TransactionDefectRate metric. |
| CasesClosedWithoutSellerResolutionLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. |
| LateShipmentRateLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the LateShipmentRate metric. |
| TrackingUploadedOnTimeAndValidatedLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. |
| SalesAmountCurrency | String | The sales amount currency. |
Returns a report that details the user traffic received by a seller's listings per day.
The Cloud will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
To query the TrafficReportByDay view, a value for the MarketplaceId and the report date range via the columns ReportStartDate and ReportEndDate should be specified.
The MarketplaceId is server side filterable and supports the operators: "=" and "IN".
Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.
The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.
The ListingId is server side filterable and supports the operators: "=" and "IN".
The example query below will return TrafficReportByDay data for the Marketplace specified in the MarketplaceId connection property and for the last 90 days.
SELECT * FROM TrafficReportByDay
The other example query below, will return TrafficReportByDay data for the specified listings in the US Marketplace within the defined date range.
SELECT * FROM TrafficReportByDay WHERE ListingId IN ('182227914336', '182283742135', '311698881010') AND MarketplaceId = 'EBAY_US' AND ReportStartDate = '2019-07-12' AND ReportEndDate = '2019-09-13'
| Name | Type | Description |
| Day | Date | The Day (individual date) by which the metrics are grouped. |
| ClickThroughRate | Double | 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 | 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 | 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 | 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 | 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 | 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 | 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 | The number of times the item displayed on the search results page. |
| ListingViewsSourceStore | Integer | The number of times a View Item page was accessed via the seller's store. |
| ListingViewsTotal | Integer | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. |
| SalesConversionRate | Double | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. |
| TotalImpressionTotal | Integer | 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 | The total number of completed transactions. |
| UsageStartDate | Datetime | The start date of the actual date range of the report data. |
| UsageEndDate | Datetime | The end date of the actual date range of the report data. |
| LastUpdatedDate | Datetime | The last time the data returned in the report was updated. |
| ReportStartDate | Date | The requested start date of the date range used to calculate the report. |
| ReportEndDate | Date | 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the seller report is limited. |
| ListingId | String | The Id of the Listing by which the metrics are grouped. You can get your ListingId-s from the TrafficReportByListing view. |
Returns a report that details the user traffic received by a seller's listings per listing.
The Cloud will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
To query the TrafficReportByListing view, at least the report date range via the columns ReportStartDate and ReportEndDate should be specified.
The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.
The MarketplaceId input supports the operators: "=" and "IN".
Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.
The ListingId column is server side filterable and supports the operators: "=" and "IN".
The example query below will return TrafficReportByListing data for every available Marketplace, including every Listing the last 90 days.
SELECT * FROM TrafficReportByListing
The other example query below, will return TrafficReportByListing data for the specified listings in the GB Marketplace within the defined date range.
SELECT * FROM TrafficReportByListing WHERE ReportStartDate = '2019-06-20' AND ReportEndDate = '2019-09-15' AND ListingId IN ('201294636968', '201450979387', '201461563488') AND MarketplaceId = 'EBAY_GB'
| Name | Type | Description |
| ListingId | String | The Id of the Listing by which the metrics are grouped. |
| ListingName | String | The Listing Name. |
| ClickThroughRate | Double | 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 | 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 | 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 | 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 | 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 | 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 | 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 | The number of times the item displayed on the search results page. |
| ListingViewsSourceStore | Integer | The number of times a View Item page was accessed via the seller's store. |
| ListingViewsTotal | Integer | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. |
| SalesConversionRate | Double | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. |
| TotalImpressionTotal | Integer | 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 | The total number of completed transactions. |
| UsageStartDate | Datetime | The start date of the actual date range of the report data. |
| UsageEndDate | Datetime | The end date of the actual date range of the report data. |
| LastUpdatedDate | Datetime | The last time the data returned in the report was updated. |
| ReportStartDate | Date | The requested start date of the date range used to calculate the report. |
| ReportEndDate | Date | 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the seller report is limited. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with eBay Analytics.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from eBay Analytics, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for eBay Analytics:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the TrafficReportByListing table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='TrafficReportByListing'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native eBay Analytics procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the TrafficReportByListing table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='TrafficReportByListing'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are OAuth and OAuthClient. |
| Property | Description |
| RuName | The Redirect URL name used for validation. |
| UseSandbox | A boolean indicating if you are using a sandbox account. |
| MarketplaceId | The identification number for the eBay Marketplace. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are OAuth and OAuthClient. |
The scheme used for authentication. Accepted entries are OAuth and OAuthClient.
string
"OAuth"
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
| Property | Description |
| RuName | The Redirect URL name used for validation. |
| UseSandbox | A boolean indicating if you are using a sandbox account. |
| MarketplaceId | The identification number for the eBay Marketplace. |
The Redirect URL name used for validation.
string
""
It is not necessary when refreshing the Access Token. This property is only needed when performing the Code grant type OAuth flow to get an Access Token. You can obtain this by clicking "User Tokens" from your developer account, clicking "Get a Token from eBay via Your Application", and then clicking "Add eBay Redirect URL".
A boolean indicating if you are using a sandbox account.
bool
false
A boolean indicating if you are using a sandbox account.
The identification number for the eBay Marketplace.
string
"DEFAULT"
By default, it has no value assigned to it, this means that to query the reports: CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, TrafficReportByDay and TrafficReportByListing, you must specify the MarketplaceId/s in the query criteria.
You should note that each report is supported in distinct marketplaces, as outlined in the below.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies whether or not throws an exception if there is no rows updated.
bool
false
Specifies whether or not throws an exception if there is no rows updated.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.