Create a connection to eBay Analytics by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the eBay Analytics icon is not available, click the Add More icon to download and install the eBay Analytics connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Authenticating to eBay Analytics

You can 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.

You can follow the guide on Using OAuth Authentication for a step by step guide on how to authenticate using the OAuth 2 protocol.

This section details a selection of advanced features of the eBay Analytics Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to eBay Analytics and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API resources and provides more information on executing SQL to eBay Analytics APIs.

Key Features

• The Sync App models eBay Analytics reports as relational views, allowing you to write SQL to query eBay Analytics data.
• Stored procedures allow you to execute operations to eBay Analytics.
• Live connectivity to these objects means any changes to your eBay Analytics account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, SellerStandardsProfile, TrafficReportByDay and TrafficReportByListing.

Stored Procedures

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 composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

eBay Analytics Connector for CData Sync Views

Returns a seller's performance and rating for the customer service metric by the primary proudct categories.

Select

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.

• In case, the MarketplaceId is not specified, the value set in the MarketplaceId connection property will be used instead by default.

  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.

• In case, the EvaluationType is not specified, the eBay Analytics will generate a report based on the data for the CURRENT period.

  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.

• The seller has a valid transaction on the specified marketplace (MarketplaceId) during the past 12 months.
• If the 'CURRENT' EvaluationType is specified, the seller must have been active on the specified marketplace (MarketplaceId) for a complete benchmarking period (eBay evaluation period, usually one month).

Columns

Returns a seller's performance and rating for the customer service metric by the established shipping corridors.

Select

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.

• In case, the MarketplaceId is not specified, the value set in the MarketplaceId connection property will be used instead by default.

  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.

• In case, the EvaluationType is not specified, the eBay Analytics will generate a report based on the data for the CURRENT period.

  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.

• The seller has a valid transaction on the specified marketplace (MarketplaceId) during the past 12 months.
• If the 'CURRENT' EvaluationType is specified, the seller must have been active on the specified marketplace (MarketplaceId) for a complete benchmarking period (eBay evaluation period, usually one month).

Columns

Returns the standards profiles for the associated seller.

Select

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.

• Supported values for the Program column are: PROGRAM_DE, PROGRAM_UK, PROGRAM_US and PROGRAM_GLOBAL.
• Supported values for the Cycle column are: CURRENT and PROJECTED.

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

Columns

Returns a report that details the user traffic received by a seller's listings per day.

Select

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.

• In case, the MarketplaceId is not specified, the value set in the MarketplaceId connection property will be used instead by default.

  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.

• In case, the report range (ReportStartDate and ReportEndDate) is not specified or partly specified, the driver will return the data for the last 90 days or 90 days before or after the partly specified range depending on which date range parameter is missing.

  The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.

• Additionally the user can limit the report data to a listing or to a group of listings via the ListingId input.

  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'

Columns

Pseudo-Columns

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.

Returns a report that details the user traffic received by a seller's listings per listing.

Select

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.

• In case, the report range (ReportStartDate and ReportEndDate) is not specified or partly specified, the driver will return the data for the last 90 days or 90 days before or after the partly specified range depending on which date range parameter is missing.

  The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.

• The MarketplaceId input is server side filterable and can be used to limit the report data only to the specified Marketplaces.

  The MarketplaceId input supports the operators: "=" and "IN".

  Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.

• Additionally the user can limit the report data to a listing or to a group of listings via the ListingId column.

  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'

Columns

Pseudo-Columns

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.

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.

Authentication

Connection

OAuth

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

The scheme used for authentication. Accepted entries are OAuth and OAuthClient.

Remarks

• OAuth: Set to this to perform OAuth authentication with the code grant type.
• OAuthClient: Set to this to perform OAuth with the client credentials grant type.

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

The Redirect URL name used for validation.

Remarks

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.

Remarks

A boolean indicating if you are using a sandbox account.

The identification number for the eBay Marketplace.

Remarks

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.

• CustomerServiceMetricByCategory: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).
• CustomerServiceMetricByShippingRegion: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).
• TrafficReportByDay: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).
• TrafficReportByListing: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

The grant type for the OAuth flow.

Remarks

The following options are available: CODE,CLIENT

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

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:

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.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) 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" with %APPDATA% being set to the user's configuration directory:

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that 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.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom 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)"
	}
}

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"