The CData Sync App provides a straightforward way to continuously pipeline your eBay Analytics data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The eBay Analytics connector can be used from the CData Sync application to pull data from eBay Analytics and move it to any of the supported destinations.
The Sync App leverages the EbayAnalytics API to enable bidirectional access to EbayAnalytics.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
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.
This section details a selection of advanced features of the eBay Analytics Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App 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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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. |
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 |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| OAuthGrantType | Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
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.
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.
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.
A boolean indicating if you are using a sandbox account.
The identification number for the eBay Marketplace.
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 OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| OAuthGrantType | Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.
In most cases, the default grant type should not be modified. For information about the most common OAuth grant types and the trade-offs between them, see https://oauth.net/2/grant-types/.
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.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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 |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to eBay Analytics. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to eBay Analytics. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to eBay Analytics. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\EbayAnalytics Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
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.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
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 rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App 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 the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
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.
Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM TrafficReportByListing WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.