This page provides a guide to Establishing a Connection to Adobe Analytics in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Adobe Analytics

Establishing a Connection shows how to authenticate to Adobe Analytics and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Adobe Analytics through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Adobe Analytics by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Adobe Analytics

To connect to Adobe Analytics, both the GlobalCompanyId and RSID must be identified. By default, the Cloud attempts to identify your company and report suite automatically. However, you can also specify these values explicitly:

Global Company Id

The GlobalCompanyId is an optional connection property. If left empty, the Cloud attempts to automatically detect the Global Company ID. To find the Global Company ID:

1. Locate it in the request URL for the users/me endpoint on the Swagger UI.
2. Expand the users endpoint, then click GET users/me.
3. Click Try it out > Execute.
4. Set the GlobalCompanyId connection property to the Global Company ID shown in the request URL immediately preceding the users/me endpoint.

Report Suite Id

RSID is also an optional connection property. If not set, the driver tries to detect it automatically. To view all of your report suites and their identifiers, go to Admin > Report Suites.

Authenticating to Adobe Analytics

Adobe Analytics uses the OAuth authentication standard. You can authenticate with OAuth integration or Service Account integration.

User Accounts (OAuth)

You must set AuthScheme to OAuth for all user account flows.

Service Account

Service accounts have silent authentication, which does not require user authentication in the browser.
You need to create an application for this flow. Review Creating a Custom OAuth App to create and authorize an application. You can then connect to Adobe Analytics data that the service account has permission to access.

Server-to-Server OAuth

Set the AuthScheme to OAuthClient to authenticate with this method.

Set the following properties to connect:

• OAuthClientId: Set to the client Id in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.

When you connect, the Cloud completes the OAuth flow for a service account.

You must create a custom OAuth app to connect to the Adobe Analytics.

Create an App for OAuth Integration

Follow the steps below to create a custom app and obtain the connection properties in a specific OAuth authentication flow.

1. Navigate to the following URL: https://console.adobe.io/home.
2. Click the Create new project button.
3. Select the Add API option.
4. Select Adobe Analytics, click Next, and then select OAuth and then click Next again.
5. Select the Web option and fill out the redirect URIs. For a desktop application, you can use a localhost URL such as https://localhost:33333. For a web application, supply the URL of the page to redirect to on your website.
6. Click Save configured API.

Your client is now created. Notice your client has an Client ID (API Key) and a Client Secret. These will be needed to get your auth code and to generate access tokens.

Create an App for Service Account Integration

Use the following steps to create a custom app and obtain the connection properties in a specific Service Account authentication flow.

1. Navigate to the following URL: https://console.adobe.io/home.
2. Click Create new project.
3. Select Add API.

For Server-to-Server OAuth:

1. Select Adobe Analytics, click Next, then select OAuth Server-to-Server and click Next again.
2. Select one or more product profiles (you can set app permissions in product profiles) and click Save configured API.

Your client is now created. You will have the Client ID (API Key) and Client Secret, which are needed to generate access tokens.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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.

The CData Cloud models Adobe Analytics objects as an easy-to-use SQL database, using views and stored procedures. These are defined in schema files, which are simple, easy-to-read text files that define the structure and organization of data.

Views

The Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Adobe Analytics account.

The following views are included with the application:

View	Description
CalculatedMetrics	Retrieve a list of all calculated metrics defined within your Adobe Analytics environment, including custom formulas built on top of standard metrics.
CollectionSuites	Return the list of data collection suites configured in Adobe Analytics, which represent logical groupings of tracking data within a report suite.
Dimensions	List all available dimensions that can be used to segment and break down Adobe Analytics data, such as page name, device type, or campaign.
KeyMetrics	Display high-level engagement metrics like page views and visits for a specified time range (defaults to the past 30 days).
LastTouchChannel	Identify the last marketing channel attributed to each visitor during their session, based on Adobe's last-touch attribution model.
LastTouchChannelDetail	View detailed attributes of the last-touch marketing channel, such as referring domain, tracking code, or campaign ID.
Metrics	Retrieve all available standard and custom metrics that measure user behavior and site performance in Adobe Analytics.
Orders	Summarize the total number of purchase events recorded across all tracked orders within a specified time period (defaults to 30 days).
PageOccurrences	Display the number of times a page was involved in a tracked interaction or persisted as a dimension value within the selected reporting window.
Pages	Identify pages on your site ranked by popularity, based on views and interactions during a selected reporting period (defaults to 30 days).
PageViews	Show the total number of page views recorded, helping you understand overall traffic volume over a specified date range.
Products	Return order counts grouped by product name or SKU, allowing analysis of top-performing items sold within the last 30 days.
Revenue	Aggregate the total revenue generated from all completed orders within the reporting period (defaults to 30 days).
Segments	Retrieve the list of predefined and custom segments available in your Adobe Analytics account, including shared and curated segments.
SiteSections	Identify the most trafficked or highest-converting sections of your site, based on page grouping and content hierarchy.
TrackingCode	View which marketing or campaign tracking codes drove the most traffic to your site over a given period.
Units	Show the total number of individual product units purchased across all orders in the selected reporting window.
UniversalReport	Run a unified report that includes all configured dimensions and metrics for a broad view of user behavior and performance.
Users	List the users who have access to Adobe Analytics, including login details, roles, and account status.
Visitors	Display the total number of unique individuals who accessed your site during the reporting period (defaults to the past 30 days).
Visits	Show the number of individual sessions recorded during the specified date range, regardless of visitor identity.

Stored Procedures

Stored Procedures are SQL scripts that extend beyond standard CRUD operations. They can be used to access additional capabilities of the Adobe Analytics API.

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.

CData Cloud - Adobe Analytics Views

Name	Description
CalculatedMetrics	Retrieve a list of all calculated metrics defined within your Adobe Analytics environment, including custom formulas built on top of standard metrics.
CollectionSuites	Return the list of data collection suites configured in Adobe Analytics, which represent logical groupings of tracking data within a report suite.
Dimensions	List all available dimensions that can be used to segment and break down Adobe Analytics data, such as page name, device type, or campaign.
KeyMetrics	Display high-level engagement metrics like page views and visits for a specified time range (defaults to the past 30 days).
LastTouchChannel	Identify the last marketing channel attributed to each visitor during their session, based on Adobe's last-touch attribution model.
LastTouchChannelDetail	View detailed attributes of the last-touch marketing channel, such as referring domain, tracking code, or campaign ID.
Metrics	Retrieve all available standard and custom metrics that measure user behavior and site performance in Adobe Analytics.
Orders	Summarize the total number of purchase events recorded across all tracked orders within a specified time period (defaults to 30 days).
PageOccurrences	Display the number of times a page was involved in a tracked interaction or persisted as a dimension value within the selected reporting window.
Pages	Identify pages on your site ranked by popularity, based on views and interactions during a selected reporting period (defaults to 30 days).
PageViews	Show the total number of page views recorded, helping you understand overall traffic volume over a specified date range.
Products	Return order counts grouped by product name or SKU, allowing analysis of top-performing items sold within the last 30 days.
Revenue	Aggregate the total revenue generated from all completed orders within the reporting period (defaults to 30 days).
Segments	Retrieve the list of predefined and custom segments available in your Adobe Analytics account, including shared and curated segments.
SiteSections	Identify the most trafficked or highest-converting sections of your site, based on page grouping and content hierarchy.
TrackingCode	View which marketing or campaign tracking codes drove the most traffic to your site over a given period.
Units	Show the total number of individual product units purchased across all orders in the selected reporting window.
UniversalReport	Run a unified report that includes all configured dimensions and metrics for a broad view of user behavior and performance.
Users	List the users who have access to Adobe Analytics, including login details, roles, and account status.
Visitors	Display the total number of unique individuals who accessed your site during the reporting period (defaults to the past 30 days).
Visits	Show the number of individual sessions recorded during the specified date range, regardless of visitor identity.

Retrieve a list of all calculated metrics defined within your Adobe Analytics environment, including custom formulas built on top of standard metrics.

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Id [KEY]	String					System-assigned unique ID used to reference the calculated metric in API calls, queries, or configuration files.
Name	String					Descriptive label for the calculated metric, used in dashboards, reports, and metric selectors.
ReportSuiteName	String					Name of the Adobe Analytics report suite in which the calculated metric is defined.
Description	String					Clarifies the metric's purpose, formula logic, and how it contributes to business analysis.
Created	Datetime					Timestamp of when the calculated metric was first created within Adobe Analytics.
Modified	Datetime					Timestamp of the last modification to the metric's configuration, logic, or metadata.
Type	String					Data type used to format the calculated metric's output. Common values: int, decimal, percentage, currency.
OwnerId	String					ID of the Adobe Analytics user who originally created the calculated metric.
OwnerName	String					Full name of the user listed as the creator and owner of the metric.
Category	String					User-defined tag or folder used to categorize the calculated metric for easier management.
SiteTitle	String					Title of the website or digital asset linked to the report suite where this metric is used.
Polarity	String					Indicates whether a higher value for the metric is favorable or unfavorable. Valid values: positive, negative.
Precision	Integer					Controls the number of digits displayed after the decimal point for the metric in reports.
Template	String					Template ID used to generate this metric from a predefined calculation blueprint. Applies only when IncludeType = templates.

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.

Name	Type	Description
IncludeType	String	Determines which types of calculated metrics to return. Options: all (all company metrics), shared (metrics shared with the user), and templates (metric templates only).

Return the list of data collection suites configured in Adobe Analytics, which represent logical groupings of tracking data within a report suite.

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Rsid [KEY]	String					Unique identifier of the collection suite.
Name	String					The name of the collection suite.
ParentRsid	String					Unique identifier of the parent of this collection suite.
Currency	String					Default currency used in this collection suite.
Type	String					The type of the collection suite. For example, report suite.
Timezone	String					The timezone of the collection suite.

List all available dimensions that can be used to segment and break down Adobe Analytics data, such as page name, device type, or campaign.

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Id [KEY]	String					Unique identifier of the dimension.
RSID	String					Unique identifier of the report suite the dimension is in.
Title	String					The title of the dimension.
Name	String					The name of the dimension.
Type	String					The type of the dimension. For example string, int, enum etc.
Description	String					A description of the dimension.
Category	String					The category of the dimension.
Pathable	Boolean					Whether or not the dimension is pathable.
Segmentable	Boolean					Whether or not the dimension is segmentable.
ReportType	String					The type of the reports in which this dimension is valid.
Support	String					The type of the reports in which this dimension is supported.

Display high-level engagement metrics like page views and visits for a specified time range (defaults to the past 30 days).

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [KeyMetrics] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The day the given metrics occurred.
PageViews	Int		True		True	The number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports.
Visits	Int		True		True	The number of sessions across all visitors on the site.
UniqueVisitors	Int		True		True	The number of unique individuals who have visited the site during a specified time period. This can help you understand the overall reach of the site.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Identify the last marketing channel attributed to each visitor during their session, based on Adobe's last-touch attribution model.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [LastTouchChannel] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
LastTouchChannel	String	True		True		The most recent marketing channel attributed to a visitor before a conversion or key interaction, based on Adobe Analytics attribution rules.
UniqueVisitors	Int		True		True	The count of distinct users who visited the site during the selected date range, based on browser cookies or visitor IDs.
StartDate	String					The start date for the reporting period used to filter and return relevant data.
EndDate	String					The end date for the reporting period used to filter and return relevant data.
SegmentId	String					The ID of a user-defined or system-defined segment used to limit the report data to specific audience criteria.

View detailed attributes of the last-touch marketing channel, such as referring domain, tracking code, or campaign ID.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [LastTouchChannelDetail] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
LastTouchChannelDetail	String	True		True		Specific subcategory or granular value of the last marketing channel attributed to a visitor before a conversion or significant interaction.
UniqueVisitors	Int		True		True	The number of distinct users who accessed the site during the defined reporting period, based on visitor identification mechanisms.
StartDate	String					The starting date of the reporting window used to filter data.
EndDate	String					The ending date of the reporting window used to filter data.
SegmentId	String					The unique identifier of a segment used to restrict the dataset to a specific audience or behavior group.

Retrieve all available standard and custom metrics that measure user behavior and site performance in Adobe Analytics.

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Id [KEY]	String					Unique identifier of the metric.
RSID	String					Unique identifier of the report suite the metric is in.
Title	String					The title of the metric.
Name	String					The name of the metric.
Type	String					The type of the metric, for example int, percent, currency etc.
Description	String					A description for the metric.
Category	String					The category of the metric.
Calculated	Boolean					Whether or not this metric is calculated metric.
Segmentable	Boolean					Whether or not this metric is segmentable.
Polarity	String					Takes two value: positive and negative. Determines if it's positive or not if the metric increases.
Precision	Integer					The precision of the metric.

Summarize the total number of purchase events recorded across all tracked orders within a specified time period (defaults to 30 days).

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [Orders] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The day the given metric occurred.
Orders	Int		True		True	The total number of purchase events made on your site. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to an order.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Display the number of times a page was involved in a tracked interaction or persisted as a dimension value within the selected reporting window.

This predefined report view is based on the 'Next Page' and 'Previous Page' Adobe Analytics template. If no segment filter is specified, this view returns a report containing only the Page dimension and the Occurrences metric. To generate a 'Next Page' or 'Previous Page' report, you must specify the corresponding segment using the SegmentId column in the WHERE clause.

By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

An example query would be:

SELECT * FROM [PageOccurrences] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Page	String	True		True		The names of pages on your site.
Occurrences	Double		True		True	The number of hits where a given dimension was set or persisted.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Identify pages on your site ranked by popularity, based on views and interactions during a selected reporting period (defaults to 30 days).

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [Pages] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Page	String	True		True		The names of pages on your site.
PageViews	Int		True		True	Shows the number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Show the total number of page views recorded, helping you understand overall traffic volume over a specified date range.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [PageViews] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The day the given metric occurred.
PageViews	Int		True		True	Shows the number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Return order counts grouped by product name or SKU, allowing analysis of top-performing items sold within the last 30 days.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [Products] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Product	String	True		True		The name of the product in the hit.
Orders	Int		True		True	The total number of purchase events made on your site. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to an order.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Aggregate the total revenue generated from all completed orders within the reporting period (defaults to 30 days).

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [Revenue] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The day the given metric occurred.
Revenue	Decimal		True		True	The monetary amount of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to revenue.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Retrieve the list of predefined and custom segments available in your Adobe Analytics account, including shared and curated segments.

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Id [KEY]	String					Unique identifier of the segment.
Name	String					The name of the segment.
ReportSuiteName	String					The name of the report suite the segment was created in.
Description	String					A description for the segment.
Created	Datetime					The datetime the segment was created.
Modified	Datetime					The datetime the segment was last modified.
OwnerId	String					The unique identifier of the user that created the segment.
OwnerName	String					The name of the user that created the segment.
Version	String					The version of the segment.
Type	String					A comma-separated list of segment types. Allowed values are: shared,templates,curatedItem .
SiteTitle	String					The title of the site.

Identify the most trafficked or highest-converting sections of your site, based on page grouping and content hierarchy.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [SiteSections] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
SiteSection	String	True		True		The names of site sections on your site.
Visits	Int		True		True	The number of sessions across all visitors on the site.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

View which marketing or campaign tracking codes drove the most traffic to your site over a given period.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [TrackingCode] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
TrackingCode	String	True		True		The names of tracking codes on your site.
Visits	Int		True		True	The number of sessions across all visitors on the site.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Show the total number of individual product units purchased across all orders in the selected reporting window.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [Units] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The day the given metric occurred.
Units	Int		True		True	The total number of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to the number of products purchased.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Run a unified report that includes all configured dimensions and metrics for a broad view of user behavior and performance.

View Specific Information

Select

This view includes every available dimension and metric. To create a valid custom Adobe Analytics report, ensure your SELECT query includes at least one metric column along with any desired subset of dimension columns from the list.

To define the reporting period, specify the StartDate and EndDate in your WHERE clause. If no dates are specified, the report defaults to a period starting from two years ago up to today. If only a StartDate is provided, the EndDate defaults to today, and if only an EndDate is provided, the StartDate defaults to two years ago from the specified EndDate.

You can also filter the report to a specific segment by including the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT [Time Spent on Page - Bucketed], [Browser], [Browser Height - Bucketed], [Browser Type], [Average Page Depth], [Average Time Spent on Site (seconds)], [Bot Occurrences], [Bot Page Views], [Bounce Rate] FROM [UniversalReport] 
WHERE [StartDate] = '2023-01-01' AND [EndDate] = '2023-01-31' AND [SegmentId] = 's300012345_1234567890'

This approach enables you to generate a tailored report by choosing the specific columns and applying the necessary date range and segment filters directly in your query.

Default Dimension

Date is the default dimension for this report as well, so the query:

    SELECT * FROM [UniversalReport]

will become:

    SELECT Date, {all the metrics here} FROM [UniversalReport]

Default Metric

Occurrences is the default metric for this report if no valid metric is specified in the query, so the query:

    SELECT Date FROM [UniversalReport]

will become:

    SELECT Date, Occurrences FROM [UniversalReport]

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The 'Date' dimension.
Occurrences	Int		True		True	The number of hits where a given dimension was set or persisted.
Time Spent on Page - Bucketed	String	True				The amount of time a visitor spends on the page. The amount of time is categorized into different time ranges or
Bot Name	String	True				Shows the names of the bots detected or custom bot rules supplied.
Browser	String	True				Shows the name and version of the browser used to access the site.
Browser Height - Granular	String	True				Categorizes site visitors based on the height of their browser window.
Browser Height - Bucketed	String	True				Shows the height of the browser window, classified in groups of 100 pixels.
Browser Type	String	True				Shows the name of browser providers used to access the site (such as Google and Apple).
Browser Width - Granular	String	True				Shows the width of the browser window, classified in groups of 100 pixels.
Browser Width - Bucketed	String	True				Shows the width of the browser window, classified in groups of 100 pixels. This can help you optimize content for viewing.
Tracking Code	String	True				The 'Tracking Code' dimension.
Category	String	True				The product category of the hit. If your implementation uses the 'products' variable, this can help you see metrics about the product category, such as top sellers or most viewed.
ClickMap Action (Legacy)	String	True				Identifies the type of click that a visitor made on a specific element of a web page.
ClickMap Action Type (Legacy)	String	True				The 'ClickMap Action Type (Legacy)' dimension.
ClickMap Context (Legacy)	String	True				The 'ClickMap Context (Legacy)' dimension.
ClickMap Context Type (Legacy)	String	True				The 'ClickMap Context Type (Legacy)' dimension.
ClickMap Source ID (Legacy)	String	True				The 'ClickMap Source ID (Legacy)' dimension.
ClickMap Tag (Legacy)	String	True				The 'ClickMap Tag (Legacy)' dimension.
Code Version	String	True				The 'Code Version' dimension.
Color Depth	String	True				The number of colors that a screen supports.
Connection Type	String	True				The method used by a visitor to connect to the internet, such as a wired or wireless connection. This can help you know how to optimize site content based on visitors' connection speeds.
Cookie Support	String	True				Whether a visitor's browser supports cookies for a given hit. This can help you determine the ratio of visitors who use browsers that support cookies, and those who intentionally disable them.
Currency	String	True				The 'Currency' dimension.
Currency Factor	String	True				The 'Currency Factor' dimension.
Currency Rate	String	True				The 'Currency Rate' dimension.
Custom Hit Time UTC	String	True				The 'Custom Hit Time UTC' dimension.
Customer Loyalty	String	True				The degree to which visitors consistently engage with and return to the site over time. This can help you understand how the site affects purchasing behavior.
Customer Perspective	String	True				The 'Customer Perspective' dimension.
Custom Link	String	True				Shows the names of custom links on your site. This can help you understand the types of links visitors most often click.
Custom Visitor ID	String	True				The 'Custom Visitor ID' dimension.
Daily Unique Customers	String	True				The number of unique visitors per day.
Hour	String	True				The hour that a given metric occurred (rounded down). This can help you see metrics over time in trended reports.
Minute	String	True				The minute that a given metric occurred (rounded down). This can help you see metrics over time in trended reports.
Month	String	True				The month that a given metric occurred. This can help you see metrics over time in trended reports.
Quarter	String	True				The quarter that a given metric occurred. This can help you see metrics over time in trended reports.
Week	String	True				The week that a given metric occurred. This can help you see metrics over time in trended reports.
Year	String	True				The year that a given metric occurred.
Days Before First Purchase	String	True				The number of days between a user's first visit to a website and their first purchase.
Days Since Last Purchase	String	True				The number of days between a visitor's current visit and their most recent purchase. This can help you understand visitor behavior after making a purchase on the site.
Days Since Last Visit	String	True				The number of days between a visitor's current visit and their most recent visit. This can help you understand visitor behavior after visiting the site.
Domains	String	True				Access points that visitors use to access the internet.
Download Link	String	True				The names of download links on the site. This can help you understand things like which files are downloaded most frequently and whether visitors download different file types if offered.
Duplicate Purchase	String	True				The 'Duplicate Purchase' dimension.
Entry Page	String	True				The names of pages on your site. This can help you understand which pages on your site perform the best. This is one of the most commonly used dimensions.
Visit Start Page	String	True				The 'Visit Start Page' dimension.
Entry Page Original	String	True				The first page viewed by a visitor when they enter the site.
Entry Custom Insight 1	String	True				The 'Entry Custom Insight 1' dimension.
Entry Custom Insight 2	String	True				The 'Entry Custom Insight 2' dimension.
Entry Custom Insight 3	String	True				The 'Entry Custom Insight 3' dimension.
Entry Custom Insight 4	String	True				The 'Entry Custom Insight 4' dimension.
Entry Custom Insight 5	String	True				The 'Entry Custom Insight 5' dimension.
Entry Server	String	True				The 'Entry Server' dimension.
Entry Site Section	String	True				Lists the names of site sections on your site. For large sites, it is helpful to group pages into sections. This dimension is useful to see the top-viewed or top-performing site sections.
Internal Campaign	String	True				The 'Internal Campaign' dimension.
Internal Search Terms	String	True				The 'Internal Search Terms' dimension.
Exit Link	String	True				The names of links that leads visitors away from the site. This can help you understand which links are most popular that point to domains outside of your site.
Exit Page	String	True				The names of pages on your site. This can help you understand which pages on your site perform the best. This is one of the most commonly used dimensions.
Exit Server	String	True				The 'Exit Server' dimension.
Exit Site Section	String	True				Lists the names of site sections on your site. For large sites, it is helpful to group pages into sections. This dimension is useful to see the top-viewed or top-performing site sections.
Domain	String	True				The 'Domain' dimension.
First Touch Channel	String	True				The first marketing channel a visitor matches with during their engagement period. This can help you understand which marketing channels drive initial traffic to the site.
First Touch Channel Detail	String	True				The first marketing channel a visitor matches with during their engagement period. This can help you understand what contributed to the hit matching a marketing channel.
Cities	String	True				The geographic location of a visitor at the city level.
Geo Segmentation Cities	String	True				The 'Geo Segmentation Cities' dimension.
Countries	String	True				The geographic location of a visitor at the country level.
US DMA	String	True				The geographic location of a visitor at the Designated Market Area (DMA) level.
Geo Latitude	String	True				The 'Geo Latitude' dimension.
Geo Longitude	String	True				The 'Geo Longitude' dimension.
Regions	String	True				The geographic location of a visitor at the region level.
Geo Zip	String	True				The 'Geo Zip' dimension.
Hit Datetime	String	True				The date and time of a visitor's interaction with the site.
Hit Date Time Offset	String	True				The 'Hit Date Time Offset' dimension.
Hit Depth	String	True				How far into a visit a given hit is. This can help you understand how long it takes for visitors to perform actions on the site.
Hit Time UTC	String	True				The 'Hit Time UTC' dimension.
First Hit Time UTC	String	True				The 'First Hit Time UTC' dimension.
Hit Type	String	True				Shows whether a mobile app was in the foreground or background when the hit was sent to Adobe data collection servers.
Home Page	String	True				The 'Home Page' dimension.
IP Address	String	True				The 'IP Address' dimension.
IP Address 2	String	True				The 'IP Address 2' dimension.
Java Enabled	String	True				Determines if a visitor's browser at the time of a visit has Java enabled. This is helpful if you want to introduce Java-based functionality on the site but you aren't sure how many visitors already have Java enabled.
Javascript Support	String	True				The 'Javascript Support' dimension.
Javascript Version	String	True				The 'Javascript Version' dimension.
Language	String	True				A visitor's preferred language as defined in the browser. This can aid in localization efforts by helping you understand the languages most preferred by visitors.
Last Touch Channel	String	True				The most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand which marketing channels drive traffic to your site that result in conversions.
Last Touch Channel Detail	String	True				Details about the most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand what contributed to the hit matching a marketing channel.
Latitude	String	True				The 'Latitude' dimension.
Visitor State	String	True				The 'Visitor State' dimension.
Longitude	String	True				The 'Longitude' dimension.
Marketing Channel	String	True				The most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand which marketing channels drive traffic to your site that result in conversions. This functions identically to the 'Last Touch Channel.'
Marketing Channel Detail	String	True				Details about the most recent marketing channel a visitor matches with during that visitor's engagement period. This can help you understand what contributed to the hit matching a marketing channel. This functions identically to the 'Last Touch Channel Detail.'
Experience Cloud Visitor ID	String	True				The 'Experience Cloud Visitor ID' dimension.
Mobile Audio Support	String	True				The file formats the device can play.
Mobile Max Bookmark Length	String	True				The maximum number of bytes that the mobile device supports in bookmarked URLs. Recent devices typically do not have a limit.
Mobile Carrier	String	True				The telecommunications company that provides cellular network connectivity to a mobile device.
Mobile Color Depth	String	True				The color depth of the mobile device, in bits.
Mobile Cookie Support	String	True				The ability of a mobile device to store and manage browser cookies.
Mobile Device	String	True				The model of the mobile device used to access the site.
Mobile Device Number	String	True				Shows if the mobile device transmits its number.
Mobile Device Type	String	True				The type of mobile device used to access the site (such as phone, tablet, or television).
Mobile DRM	String	True				The type of DRM the mobile device supports.
Mobile Max Email Length	String	True				The maximum number of bytes that the mobile device supports in an email. Recent devices typically do not have a limit.
Mobile Image Support	String	True				The ability of mobile devices that access the site to display and render images on the site.
Mobile Information Services	String	True				The types of news services supported by the device. Recent devices typically do not report this information.
Mobile Java VM	String	True				The versions of Java that the device supports.
Mobile Mail Decoration	String	True				Determines if the device supports Decomail, a feature once popular on Japanese devices.
Mobile Manufacturer	String	True				The manufacturer of the mobile device used to access the site (such as Apple or Samsung).
Mobile Net Protocols	String	True				The communication protocols used by mobile devices to access the site (such as Edge, GPRS, UMTS, and LTE).
Mobile Operating System (deprecated)	String	True				This dimension is deprecated. Use 'Operating system' instead.
Mobile Push To Talk	String	True				Determines if the device supports PTT (Push to talk), which allows the mobile device to behave similar to a two-way radio. Recent devices typically do not report this feature.
Mobile Screen Height	String	True				The height of the screen, in pixels.
Mobile Screen Size	String	True				The full dimensions of the mobile device, in pixels.
Mobile Screen Width	String	True				The width of the screen, in pixels.
Mobile Max Browser URL Length	String	True				The maximum number of characters that can be included in the site URL when accessed from a mobile browser.
Mobile Video Support	String	True				The video file formats and codecs that the mobile device supports.
Monitor Resolution	String	True				The height and width of the active display in pixels. This can help you prioritize content to make it visible to users without scrolling.
Monthly Unique Customers	String	True				The number of unique visitors per month.
New Visit	String	True				The 'New Visit' dimension.
Next Page	String	True				The 'Next Page' dimension.
Operating Systems	String	True				Provides data on the various desktop and mobile operating systems used by visitors to the site (includes operating system versions). This can help you understand which operating systems are most common if you have features that are supported only on certain operating systems.
Operating System Types	String	True				Provides data on the various desktop and mobile operating systems used by visitors to the site, regardless of the operating system version. This can help you understand which operating systems are most common if you have features that are supported only on certain operating systems.
Tracking Opt-out Reason	String	True				This dimension acts as a preview to show you data that would be excluded if you enabled Privacy Settings. This can help you determine if your implementation would be negatively impacted if you enabled Privacy Settings under Report Suite Settings.
Page	String	True				The names of pages on your site. This can help you understand which pages on your site perform the best. This is one of the most commonly used dimensions.
Page Event (Link Tracking)	String	True				The 'Page Event (Link Tracking)' dimension.
Page Event Media (Link Tracking)	String	True				The 'Page Event Media (Link Tracking)' dimension.
Page Event Var1 (Link Tracking)	String	True				The 'Page Event Var1 (Link Tracking)' dimension.
Page Event Var2 (Link Tracking)	String	True				The 'Page Event Var2 (Link Tracking)' dimension.
Page Event Var3 (Link Tracking)	String	True				The 'Page Event Var3 (Link Tracking)' dimension.
Page Name No URL	String	True				The 'Page Name No URL' dimension.
Pages Not Found	String	True				Shows URLs that contained an error. This can help you lower the number of errors that visitor get on your site.
Time Spent on Page - Granular	String	True				The amount of time a visitor spends on the page. This can help you understand how long visitors interact with a given metric on the site.
Page Type Error	String	True				The 'Page Type Error' dimension.
Page URL	String	True				The URLs on the site.
Original Entry Page URL	String	True				The 'Original Entry Page URL' dimension.
Visit Start Page URL	String	True				The 'Visit Start Page URL' dimension.
Paid Search	String	True				Compares any metric between paid search and natural search. All other hits outside search engines are omitted. This can help you understand how your paid search efforts compare with organic search.
Partner Plugins lea	String	True				The 'Partner Plugins lea' dimension.
Visit Depth	String	True				The 'Visit Depth' dimension.
Persistent Cookie Support	String	True				Shows if the hit used a visitor identifier that originated from a persistent source. The most common persistent source is from a cookie, but it can also use mobile headers and other sources.
Plugin Support	String	True				The 'Plugin Support' dimension.
Pre Loaded	String	True				The 'Pre Loaded' dimension.
Previous Page	String	True				The 'Previous Page' dimension.
Product	String	True				Shows the name of the product in the hit. If your implementation uses the products variable, it can help you understand metrics about your products, such as top sellers or most viewed.
Custom Insight 1	String	True				The 'Custom Insight 1' dimension.
Custom Insight 2	String	True				The 'Custom Insight 2' dimension.
Custom Insight 3	String	True				The 'Custom Insight 3' dimension.
Custom Insight 4	String	True				The 'Custom Insight 4' dimension.
Custom Insight 5	String	True				The 'Custom Insight 5' dimension.
Purchase ID	String	True				The 'Purchase ID' dimension.
Quarterly Unique Customers	String	True				The number of unique visitors per quarter.
Referrer	String	True				The website or source that a visitor used to arrive at the site. This can help you understand which specific URLs drive the most traffic to your site.
Original Referrer	String	True				The 'Original Referrer' dimension.
Referrer Type	String	True				The generic channels that a visitor used to arrive at the site (such as a search engine or another website).
Original Referrer Type	String	True				The 'Original Referrer Type' dimension.
Referrer Type (Visit)	String	True				The 'Referrer Type (Visit)' dimension.
Referrer (Visit)	String	True				The 'Referrer (Visit)' dimension.
Referring Domain	String	True				The domain of the website that a visitor used to arrive at the site. This can help you understand which third-party sites drive the most traffic to yours.
Original Referring Domain	String	True				The 'Original Referring Domain' dimension.
Referring Domain (Visit)	String	True				The 'Referring Domain (Visit)' dimension.
Return Frequency	String	True				Shows the time between visits from returning visitors. When a visitor returns to your site, it looks at the previous visit's timing and categorizes the current hit accordingly. This can help you gauge your site's appeal and track the impact of your content and promotions over time.
Report Suite ID	String	True				The 'Report Suite ID' dimension.
Search Engine	String	True				The search engine used to arrive at the site through a paid or natural (unpaid) search link.
Search Keyword	String	True				The words or phrases used when entering the site through a paid or natural (unpaid) search link.
Search Keyword (Visit)	String	True				The 'Search Keyword (Visit)' dimension.
Search Engine - Natural	String	True				The search engine used when entering the site through an natural (unpaid) search link.
Search Keyword - Natural	String	True				The words or phrases used when entering the site through a natural (unpaid) search link.
All Search Page Rank	String	True				The page of search results a visitor clicked through to your site. For example, if your site appears on the second page of a search engine's search results, the dimension item for this variable is
Search Engine - Paid	String	True				The search engine used when entering the site through a paid search link.
Search Keyword - Paid	String	True				The words or phrases used when entering the site through a paid search link.
Search Engine (Visit)	String	True				The 'Search Engine (Visit)' dimension.
Server	String	True				The 'Server' dimension.
Service	String	True				The 'Service' dimension.
Single Page Visits	String	True				Occurrences when visitors leave the site after viewing only a single page.
Site Section	String	True				Lists the names of site sections on your site. For large sites, it is helpful to group pages into sections. This dimension is useful to see the top-viewed or top-performing site sections.
Time Spent per Visit - Granular	String	True				The 'Time Spent per Visit - Granular' dimension.
SSL Hit	String	True				The 'SSL Hit' dimension.
Start New Visit	String	True				The 'Start New Visit' dimension.
US States	String	True				The 'US States' dimension.
AM/PM	String	True				The time of day (whether AM or PM) when a visitor accessed the site.
Day of Month	String	True				The number or percentage of visitors who access the site, categorized by month.
Day of Week	String	True				The 'Day of Week' dimension.
Day of Year	String	True				The numeric day of any given year. This allows you to view data by day, without having to use static dates as dimension items.
Hour of Day	String	True				The numeric hour of any given day. This allows you to view data by relative time of day, without having to use static hours as dimension items.
Month of Year	String	True				The month of any given year. This allows you to view data by the month of the year, without having to use a static date as dimension items.
Quarter of Year	String	True				The quarter of any given year. This allows you to view data by quarter of the year, without having to use static dates as dimension items.
Weekday/Weekend	String	True				The number or percentage of visitors who access the site, categorized by weekday and weekend.
Time Prior to Event	String	True				Reports the amount of time that passed between the first hit of the visit and the desired metric. This dimension is useful to determine the amount of time it takes to hit a success event, such as a form submission or a purchase.
Time Spent per Visit - Bucketed	String	True				Categorizes the length of time that visitors spend on the site during a single visit into different time ranges or
Time Zone	String	True				The time zone in which visitors are located when they interact with the site. This can help you understand user behavior and engagement patterns across different geographic regions.
Timezone	String	True				The 'Timezone' dimension.
Target Integration	String	True				The 'Target Integration' dimension.
Target Integration Action	String	True				The 'Target Integration Action' dimension.
Top Level Domain	String	True				The last part of a website's domain name after the final dot, such as '.com', '.org, or '.edu'. This can help you understand how visitors are accessing the site and which top-level domains are driving the most traffic.
Transaction ID	String	True				The 'Transaction ID' dimension.
Truncated Hit	String	True				The 'Truncated Hit' dimension.
User Agent Color	String	True				The 'User Agent Color' dimension.
User Agent Operating System	String	True				The 'User Agent Operating System' dimension.
User Agent Pixels	String	True				The 'User Agent Pixels' dimension.
User Agent	String	True				The 'User Agent' dimension.
User ID	String	True				The 'User ID' dimension.
New Engagement	String	True				The 'New Engagement' dimension.
New Visitor ID	String	True				The 'New Visitor ID' dimension.
Visitor ID Type	String	True				The 'Visitor ID Type' dimension.
Visit Number	String	True				The number of times a visitor accessed the site within a defined time period. This can help you understand how engaged a visitor is when returning to your site.
Visitor ID	String	True				A unique, persistent identifier assigned to each individual visitor who accesses the site. This identifier enables Adobe Analytics to track and analyze visitor behavior over time, even if the visitor is using multiple devices or browsers.
Visit Page Number	String	True				A sequential number that represents the order in which a specific page was viewed by a visitor during a given visit to the site. This can help you understand the path that visitors take as they navigate through the site, and can be used to analyze visitor behavior and engagement.
Visit Start Time UTC	String	True				The 'Visit Start Time UTC' dimension.
Weekly Unique Customers	String	True				The number of unique visitors per week.
Yearly Unique Customers	String	True				The number of unique visitors per year.
Zip Code	String	True				Categorizes site visitors based on their zip code or postal code. This can help you understand the success of local advertising or see where in the world your site performs best.
Average Page Depth	Int		True			The 'Average Page Depth' metric.
Average Time Spent on Page (seconds)	Int		True			The average amount of time visitors spend on a page.
Average Time Spent on Site (seconds)	Int		True			The total amount of time visitors interact with a specific dimension item, per sequence with a dimension item.
Average Visit Depth	Int		True			The average number of pages viewed during a single visit to the site. This can help you understand how engaged visitors are with content on the site.
Bot Occurrences	Int		True			The number of hits where a bot traffic was detected. The Bot Occurrences metric should only be used with the Bot Name, Page, or standard time dimensions (such as Day, Week, etc). If this metric is used with any other Analytics dimension, no data will result because it is unassociated with normal customer-based data in Analytics. Data processing for Bot Occurrences began between February 26 and March 10, 2023, any reporting window prior to this date will not have data. This is an Adobe provided component.
Bot Page Views	Int		True			Shows the number of times a bot was set or persisted on a page. The Bot Page Views metric should only be used with the Bot Name, Page, or standard time dimensions (such as Day, Week, etc). If this metric is used with any other Analytics dimension, no data will result because it is unassociated with normal customer-based data in Analytics. Data processing for Bot Page Views began between February 26 and March 10, 2023, any reporting window prior to this date will not have data. This is an Adobe provided component.
Bounce Rate	String		True			The ratio of visits that contained exactly one hit compared to the number of visits on that page. This can help you to understand which dimension items have the highest bounce rate, or to see an aggregated total bounce rate of your site over time.
Bounces	Int		True			The number of times a visitor leaves the site after viewing only one page. This can help you understand the top entry pages that cause visitors to bounce, or to see how bounces trend over time.
Campaign Click-throughs	Int		True			The 'Campaign Click-throughs' metric.
Cart Additions	Int		True			The number of times a visitor added something to their cart. This can help you understand at what part of the conversion funnel that customers show enough interest in a product to add it to their cart.
Cart Removals	Int		True			The number of times a visitor removes an item from their online shopping cart during a session. This can help you understand which factors might be preventing users from completing a purchase.
Carts	Int		True			The number of times visitors to the site added items to their online shopping carts.
Cart Views	Int		True			The number of times a visitor viewed their shopping cart. This can help you understand at what part of the conversion funnel that customers view the contents in their cart.
Checkouts	Int		True			The number of times visitors to the site initiated the checkout process to purchase a product or service.
Custom Link Instances	Int		True			The 'Custom Link Instances' metric.
Download Link Instances	Int		True			The number of times visitors click on download links on the site. This can help you understand how effective certain links are.
Entries	Int		True			The number of times visitors to the site first land on a given page to start their session.
Internal Campaign Instances	Int		True			The 'Internal Campaign Instances' metric.
Internal Search Terms Instances	Int		True			The 'Internal Search Terms Instances' metric.
Custom Conversion 3 Instances	Int		True			The 'Custom Conversion 3 Instances' metric.
eVar4 Instances	Int		True			Instances of metrics tied to the eVar4 dimension.
Registrations	Int		True			The 'Registrations' metric.
Email Registrations	Int		True			The 'Email Registrations' metric.
Subscriptions	Int		True			The 'Subscriptions' metric.
Page Views	Int		True			The 'Page Views' metric.
Ad Impressions	Int		True			The 'Ad Impressions' metric.
Ad Clicks	Int		True			The 'Ad Clicks' metric.
Exit Link Instances	Int		True			The number of times visitors clicked a specific link before leaving your website. This can help you understand which links are causing users to leave and potentially identify opportunities for optimization.
Exits	Int		True			The number of times a given dimension item is captured as the last value in a visit. This can help you understand the last thing visitors see before leaving your site, allowing you to optimize the experience a visitor gets before they leave.
Total Seconds Spent	Int		True			The amount of time visitors spend viewing a specific item on the site, such as a product or piece of content. This can help you understand how interested visitors are in specific products.
Total Seconds Spent	Int		True			The 'Total Seconds Spent' metric.
Marketing Channel Instances	Int		True			The 'Marketing Channel Instances' metric.
Mobile Views	Int		True			The 'Mobile Views' metric.
New Engagements	Int		True			the number of times a visitor matches a marketing channel for the first time in that visitor's engagement period. This can compare any dimension with a visitor matching a marketing channel processing rule for the first time.
Orders	Int		True			The total number of purchase events made on your site. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to an order.
Orders per Visit	Decimal		True			The ratio of orders that visitors made over the total number of visits to your site. This can help you understand conversion rate for your site.
Page Events	Int		True			Specific user interactions or actions that occur on the site, such as clicks, form submissions, video plays, downloads, and other custom events.
Pages Not Found	Int		True			Shows URLs that contained an error. This can help you lower the number of errors that visitor get on your site.
Page Views	Int		True			Shows the number of times a given dimension item was set or persisted on a page. It is one of the most common and basic metrics in reports.
Average Page Views per Visit	Decimal		True			The 'Average Page Views per Visit' metric.
Product Views	Int		True			The number of times any product was viewed. This can help you see your top-viewed products, or how total product views trend over time.
Referrer Instances	Int		True			The 'Referrer Instances' metric.
Reloads	Int		True			The number of times a dimension item was present during a reload. A visitor refreshing their browser is the most common way to trigger a reload.
Revenue	Decimal		True			The monetary amount of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to revenue.
Searches	Int		True			The number of hits that match Adobe's external search detection. This can help you understand how non-search dimensions contributed to search engine traffic.
Single Page Visits	Int		True			Occurrences when visitors leave the site after viewing only a single page.
Single Access	Int		True			The 'Single Access' metric.
Time Spent per Visit (seconds)	Int		True			The average amount of time that visitors interact with a given dimension item during each visit.
Time Spent per Visitor (seconds)	Int		True			The average amount of time that visitors interact with a given dimension item during a visitor's entire lifetime.
Units	Int		True			The total number of products purchased within all orders. This metric is vital for eCommerce sites in measuring conversion because you can combine this metric with any dimension to see which dimension items contributed to the number of products purchased.
Unique Visitors	Int		True			The number of unique individuals who have visited the site during a specified time period. This can help you understand the overall reach of the site.
Daily Unique Visitors	Int		True			The number of unique visitors to the site during each day in a given time period.
Hourly Unique Visitors	Int		True			The number of unique visitors to the site during each hour of the day. This can help you understand the time of day when the site is busiest to help optimize marketing campaigns and website content.
Visitors with Experience Cloud ID	Int		True			The number of unique visitors to the site based on their Marketing Cloud Visitor ID.
Monthly Unique Visitors	Int		True			The number of unique visitors to the site during each month in a given time period.
Quarterly Unique Visitors	Int		True			The number of unique visitors to the site during each quarter in a given time period.
Weekly Unique Visitors	Int		True			The number of unique visitors to the site during each week in a given time period.
Yearly Unique Visitors	Int		True			The number of unique visitors to the site during each year in a given time period.
Visits	Int		True			The number of sessions across all visitors on the site.
Visits - All Visitors	Int		True			The 'Visits - All Visitors' metric.
Visits	Int		True			The 'Visits' metric.
Test CM	Decimal		True			ennio testing
CalculatedMetricTest	Decimal		True			The 'CalculatedMetricTest' metric.
Revenue / Visitor	Decimal		True			The average amount of revenue generated by each individual visitor to the site.
Orders / Visitor	Decimal		True			The average number of orders or transactions generated by each individual visitor to the site.
Revenue / Visits	Decimal		True			The average amount of revenue generated by a single visit to the site.
Revenue / Order	Decimal		True			The average amount of revenue generated by each completed transaction or order on the site.
Orders / Visits	Decimal		True			The percentage of visits to the site that result in a completed transaction.
Page Views / Visits	Decimal		True			The average number of pages a user views during a single visit to the site.
Visits / Visitor	Decimal		True			The average number of visits a unique visitor makes to the site.
Reloads / Pageviews	Decimal		True			The percentage of page views that resulted in a reload or refresh of the page.
Weighted Bounce Rate	String		True			if(visits > percentile(visits),bouncerate,0)
Order Assists	Decimal		True			The number of times a channel or source contributed to a customer's journey towards making a purchase, but did not result in the final purchase.
Exit Rate	String		True			The percentage of visitors who leave the site after viewing a particular page.
Entry Rate	String		True			The percentage of visitors who entered the site on a given page, compared to the total number of sessions on the site.
Average Time on Site	String		True			The average amount of time a visitor spends on the site before leaving or navigating away.
Time Spent/User (State)	String		True			The length of time that the average visitor spends in a particular State while on the site.
Action Time In App / Users	String		True			The average amount of time visitors spend performing a specific action or task on the site.
Average Place Dwell Time	String		True			The average length of time that visitors spend on a specific section or area of a web page before moving on to another section or leaving the site.
Engagement Rate (Messages)	String		True			The percentage of visitors who send a message or initiate a conversation using the site's messaging features, such as live chat or chatbots.
States Per Launch	Decimal		True			The number of web page states or screens that a visitor views during a single session.
Launches/User	Decimal		True			The number of times a user launches a specific application or feature on the site.
Crash Rate (Mobile)	String		True			The percentage of app sessions that end in a crash or in an abnormal termination of the app.
Average Session Length (Mobile)	String		True			cm_mobile_avg_session_length_defaultmetric_localized_description_key
Users (Mobile)	Decimal		True			The total number of users of a mobile app.
App Users	Decimal		True			The total number of users of a mobile app.
State Views	Decimal		True			The number of views to the different states or screens of the app.
Actions	Decimal		True			The total number of actions taken in the app.
Acquisition Link Clicks	Decimal		True			The number of times people click a link that is designed to drive traffic to the site.
Page Velocity	Decimal		True			The number of additional page views and engagement that a piece of content generates.
Conversion Rate	String		True			The percentage of visitors who took a desired action, such as made a purchase.
Compression	String		True			The process of reducing the file size of a web page or website to improve page load times and website performance.
Devices/person	Decimal		True			The average number of devices used by a single person to access the site.
Experience Cloud ID coverage	String		True			The percentage of visitors who have an Experience Cloud ID.
In-App Message Engagement Rate	String		True			The percentage of visitors who interact with a specific in-app message, such as a push notification or banner.
Content Velocity	Decimal		True			The speed at which new content is created and published on the site and how quickly it generates user engagement.
Adobe Advertising Avg. Quality Score	Decimal		True			Evaluates the quality and relevance of the site's landing pages in the context of data from Adobe Advertising.
Adobe Advertising Avg. Position	Decimal		True			Measures the average ranking of the site's pages or ads in search engine results (using data from Adobe Advertising) when people search for specific terms relevant to your business.
Adobe Advertising ROAS	Decimal		True			Return on Advertising Spend (ROAS) measures the effectiveness and profitability of an advertising campaign (using data from Adobe Advertising).
Adobe Advertising CPC	Decimal		True			Cost Per Click (CPC) measures the cost of a digital advertising campaign (using data from Adobe Advertising).
Adobe Advertising CTR	String		True			Click-Through Rate (CTR) measures the effectiveness of digital advertising campaigns or site content in generating clicks (using data from Adobe Advertising).
Adobe Advertising Cost w Cents	Decimal		True			The total cost of a digital advertising campaign, expressed in cents (using data from Adobe Advertising).
Ad Completion Rate	String		True			The percentage of visitors who complete an ad on the site after starting it.
Ad Time Spent Rate	String		True			The amount of time viewers spend watching a video ad (displayed as a percentage of the ad's total length).
Avg. Ad Time Spent	String		True			The average amount of time that viewers spend watching a video ad on the site (HH:MM:SS).
Avg. Ads per Media Stream	Decimal		True			The average number of ads that appear during a single media stream or video on the site.
Avg. Chapter Time Spent	String		True			The average amount of time viewers spend watching a specific chapter or section of a video on the site (HH:MM:SS).
Avg. Chapters per Media Stream	Decimal		True			The average number of chapters or sections that appear during a single media stream or video on the site.
Avg. Content Time Spent	String		True			The average amount of time visitors spend engaging with a particular piece of content on the site (HH:MM:SS).
Avg. Media Time Spent	String		True			The average amount of time visitors spend engaging with a particular media element on the site, such as a video or audio clip, after the stream initiates. (HH:MM:SS).
Chapter Completion Rate	String		True			The percentage of viewers who watch a particular chapter or section of a video to its conclusion after starting it.
Content Buffer Duration Rate	String		True			The percentage of time a video or audio clip is paused for buffering during playback on the site.
Content Completion Rate	String		True			The percentage of time a video or audio clip is completed after starting.
Content Pause Duration Rate	String		True			The percentage of time a video or audio clip is paused for buffering during playback on the site.
Content Time to Start Rate	String		True			The amount of time it takes for a video or audio clip to start playing after a user clicks the play button.
Drops before Start Rate	String		True			The percentage of visitors who click the play button on a video or audio clip but abandon it before the content starts playing.
Media Completion Rate	String		True			The percentage of visitors who complete a video on the site after starting it.
ITP 2.1 Unique Visitors / Unique Visitors	String		True			The percentage of unique visitors using a browser affected by ITP 2.1 cookie limitations. In other words, customers not using a CNAME implementation. (This applies to customers setting cookies via client-side JavaScript.)
Unique Visitors / Unique Visitors returning after 7 days	String		True			The percentage of unique visitors who are returning after a period of 7 or more days.
Page Views / Unique Visitor	Decimal		True			The average number of pages viewed for each unique visitor to the site.
Visits / Visitors	Decimal		True			The average number of visits a unique visitor makes to the site.
Estimated Unique Visitors (ITP 2.1)	Decimal		True			For ITP visitors (users on Safari browsers) divide Unique Visitors by 2 or less. This assumes you are setting cookies using client-side JavaScript (not using a CNAME implementation). Implementations that set cookies using client-side JavaScript were impacted starting with ITP 2.1. See: https://webkit.org/blog/8613/intelligent-tracking-prevention-2-1/
Page Views / Estimated Unique Visitors (ITP 2.1)	Decimal		True			The average number of pages viewed for Estimated Unique Visitors (ITP 2.1).
Bots Page View Ratio	Decimal		True			The average number of Bot Page Views/Page Views.
Average Visits Per Order	String		True			The average number of visits for each order made.
Average Products Per Order	String		True			The average number of products included in each order.
Average Carts Per Order	String		True			The average number of carts included in each order.
Average Checkouts Per Order	String		True			The average number of checkouts associated with each order.
Average Revenue Per Product	Decimal		True			The average amount of revenue generated by each product.
Average Revenue Per Cart	Decimal		True			The average amount of revenue generated for each shopping cart.
Average Revenue Per Checkout	Decimal		True			The average amount of revenue generated for each checkout.
Average Revenue Per Order	Decimal		True			The average amount of revenue generated for each order.
Average Revenue Per Unit	Decimal		True			The average amount of revenue generated for each unit sold.
Average Units Per Product	Decimal		True			The average number of units included in each product.
Average Units Per Cart	Decimal		True			The average number of units included in each shopping cart.
Average Units Per Checkout	Decimal		True			The average number of units included with each checkout.
Average Units Per Order	Decimal		True			The average number of units included with each order.
Average Orders Per Product	Decimal		True			The average number of orders for each product.
Average Orders Per Cart	Decimal		True			The average number of orders included with each shopping cart.
Average Orders Per Checkout	Decimal		True			The average number of orders included with each checkout.
Average Revenue Per Visit	Decimal		True			The average amount of revenue generated for each visit.
Average Orders Per Visit	Decimal		True			The average number of orders generated with each visit.
Average Click-Throughs Per Order	String		True			The average number of click-throughs (clicks on ads or links) that are required before a single order is made.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

List the users who have access to Adobe Analytics, including login details, roles, and account status.

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
LoginId [KEY]	String					Unique identifier of the user.
ImsUserId	String					The IMS User Id. This is used only for internal users such as authors, reviewers, administrators, developers, etc.
CompanyId	String					Unique identifier of the company.
CreateDate	Timestamp					The date when user was created.
Disabled	Boolean					Whether or not this user's account is disabled.
Email	String					The email of the user.
FirstName	String					The first name of the user.
LastName	String					The last name of the user.
FullName	String					The full name of the user.
LastAccess	Timestamp					When the user accessed his account for the last time.
LastLogin	Timestamp					When the user logged in for the last time.
Login	String					Login name.
PhoneNumber	String					The phone number of the user.
Title	String					The user's title.

Display the total number of unique individuals who accessed your site during the reporting period (defaults to the past 30 days).

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [Visitors] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The day the given metric occurred.
UniqueVisitors	Int		True		True	The number of unique individuals who have visited the site during a specified time period. This can help you understand the overall reach of the site.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Show the number of individual sessions recorded during the specified date range, regardless of visitor identity.

This predefined report view is based on the corresponding Adobe Analytics template. By default, the report covers the last 30 days. To customize the date range, specify StartDate and EndDate in the WHERE clause. If only StartDate is provided, EndDate defaults to today. If only EndDate is provided, StartDate defaults to two years before the specified EndDate.

You can also filter the report by segment using the SegmentId column in the WHERE clause. For instance, an example query might be:

SELECT * FROM [Visits] WHERE [StartDate] = '2025-01-01' AND [EndDate] = '2025-01-31' AND [SegmentId] = 's300012345_1234567890'

Columns

Name	Type	IsDimension	IsMetric	DefaultDimension	DefaultMetric	Description
Date	Date	True		True		The day the given metric occurred.
Visits	Int		True		True	The number of sessions across all visitors on the site.
StartDate	String					Specifies the beginning of the reporting period.
EndDate	String					Specifies the end of the reporting period.
SegmentId	String					Specifies the ID of a predefined or custom segment to filter the report data.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Adobe Analytics.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Adobe Analytics, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Adobe Analytics Stored Procedures

Name	Description
CreateReport	Generates a custom analytics report by specifying desired dimensions, metrics, segments, and time range.

Generates a custom analytics report by specifying desired dimensions, metrics, segments, and time range.

Stored Procedure Specific Information

Use the CreateReport stored procedure to generate a custom static report. This procedure provides a way to generate new view definitions with a custom combination of dimensions and metrics. Calling it creates a new schema file that you can query like any other view.

You must set the Location connection property to the folder containing the new script files in order to access them.

You can retrieve metric and dimension Ids by querying the Metrics and Dimensions views. For example:

SELECT Id, Name FROM Dimensions
SELECT Id, Name FROM Metrics

To include calculated metrics in your report, you can retrieve the metric Id by running the following query:

SELECT Id, Name FROM CalculatedMetrics

To use a new schema along with the default schemas, set the Location property to the db subfolder in the installation folder. Then you can make any of the following calls:

EXEC CreateReport DimensionIds = 'variables/geocountry, variables/geocity', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport'
EXEC CreateReport DimensionIds = 'variables/geocountry, variables/geocity', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport', DefaultDateRage = '2025-01-01/2025-01-30'
EXEC CreateReport DimensionIds = 'variables/geocountry, variables/geocity', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport', DefaultDateRage = '2025-01-01/2025-01-30', DefaultSegmentId = 's3642_649ae61b5a255650b8391f9d'

Note that dimensions and metrics must have their respective Ids specified in the DimensionIds and MetricIds inputs.

Input

Name	Type	Required	Description
TableName	String	True	The name for the new table.
Description	String	False	An optional description for the table.
WriteToFile	String	False	Specifies whether to write the contents of this stored procedure to a file. The default value is true. Set to false to return file data through FileStream or FileData.
DimensionIds	String	True	A comma-separated list of dimension Ids.
MetricIds	String	True	A comma-separated list of metric Ids.
AllowOverride	String	False	When WriteToFile is set to true and a file with the same name already exists, this parameter specifies whether the file should be overwritten. The default value is false.
DefaultDateRage	String	False	The date range that is used as the default when executing the created report. If the date range is not specified, a range of 2 years is applied up to the date the report is executed. This value can be overridden when executing the report by specifying the StartDate and EndDate parameters. The accepted format is StartDate/EndDate (for example, 2023-01-01/2023-12-31).
DefaultSegment	String	False	An optional default segment to add to the report. Only one value is allowed.

Result Set Columns

Name	Type	Description
FileData	String	The generated schema file as a base64 string if WriteToFile is set to false; null otherwise.
Success	String	Specifies whether the schema was created successfully.
SchemaFile	String	The generated schema file path if WriteToFile is set to true; null otherwise.

Reports are shown as views, which are tables that cannot be modified. There are four types of report views:

• Custom reports defined in your Adobe Analytics instance.
• The UniversalReport view, which includes every available dimension and metric. Use it to create dynamic custom Adobe Analytics reports by selecting a subgroup of metrics and dimension columns.
• Custom static reports generated by the CreateReport Stored Procedure.
• Predefined report views, which are standard reports that replicate the output of Adobe Analytics report templates. The available predefined report views include: KeyMetrics, LastTouchChannel, LastTouchChannelDetail, Orders, PageOccurrences, Pages, PageViews, Products, Revenue, SiteSections, TrackingCode, Units, Visitors, Visits.

Unlike traditional database views, however, it is not very helpful to select all metrics and dimensions in a given table. Date is the default dimension for every report, so the query:

SELECT * FROM MyReport

becomes:

SELECT Date, {all the metrics here} FROM MyReport

But if the query has criteria, then the default dimensions are the dimensions used in the criteria. For example:

SELECT * FROM MyReport WHERE Country = 'England'

becomes:

SELECT Country, {all the metrics here} FROM MyReport WHERE Country = 'England'

Additionally, the Adobe Analytics API limits the number of dimensions you can request data from per REST API call to one. This means that the only way for the provider to generate reports with multiple dimensions is to divide dimensions into parts.

Let's take a query example:

SELECT Country, City, Visits FROM MyReport

• First, the provider requests all the values of the first dimension, Country. In this example they are England and Germany.
  
• Second, the provider tries to divide England into parts using the dimension City, and it gets London and Liverpool.
  
• Finally, it divides Germany into parts using City and gets: Berlin and Frankfurt.
  

If we have a third dimension, the provider divides every city into parts with the third dimension (which makes one request per city).

Now, imagine a four dimensional report where dimensions have many values. Typically, the generation of that report would require a lot of API calls. However, the Adobe Analytics API allows us to provide some filters that can significantly shorten the execution time of the query.

The Adobe Analytics API uses the following logical operators: 'AND', 'OR', and 'NOT', and also uses the 'MATCH', 'CONTAINS', 'BEGINS-WITH' and 'ENDS-WITH' operators, which means that criteria such as the ones below are handled server-side:

... WHERE Dimension = 'Value'
... WHERE Dimension LIKE '%value%'
... WHERE Dimension1 LIKE '%value' AND Dimension2 = 'Value2'
... WHERE Dimension LIKE 'value%'
... WHERE Dimension1 = 'Value1' AND Dimension2 = 'Value2'
... WHERE Dimension = 'Value1' OR Dimension = 'Value2' OR Dimension = 'Value3'
... WHERE Dimension IN ('Value1', 'Value2', 'Value3', 'Value4')
... WHERE (Dimension1 = 'value1' OR Dimension1 = 'Value2') AND (Dimension2 = 'value3' OR Dimension2 = 'value4')

CData strongly recommended that you use as many filters as possible; otherwise queries with many dimensions can take a lot of time.

Defining Custom Reports

To create a report view on a query, you can use the CreateReport stored procedure. This stored procedure provides an easy way to generate new view definitions with a custom combination of dimensions and metrics. Calling it creates a new schema file that you can query like any other view.

The stored procedure takes a view name, a comma-separated list of metric names, a comma-separated list of metric Ids, a comma-separated list of dimension names, a comma-separated list of dimension Ids, and an output folder as inputs.

Set the Location connection property to the folder containing the new script files in order to access them (you can set Location instead of the output folder).

Get the metric and dimension Ids by querying the Metrics and Dimensions views, as shown below:

SELECT Id, Name FROM Dimensions
SELECT Id, Name FROM Metrics

For example, to use a new schema along with the default schemas, set the Location property to the db subfolder in the installation folder and make the following call:

EXEC CreateReport Dimensions = 'Country, City', Metrics = 'PageViews, Visits', TableName = 'MyCustomReport'

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Adobe Analytics:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the SampleTable_1 table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Adobe Analytics procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the SampleTable_1 table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	Specifies the authentication scheme the provider uses to connect.
GlobalCompanyId	Specifies the Global Company ID tied to your Adobe Analytics account.
RSID	Specifies the Report Suite ID (RSID) associated with the Adobe Analytics data you want to query.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
IncludeSummaryData	Specifies whether to include summary records in the data returned from custom reports.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Adobe Analytics.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SkipEmptyRows	Specifies whether the provider skips empty rows in the output when querying report data.
SupportEnhancedBreakDown	Specifies whether the provider uses a breadth-first strategy to retrieve rows for all combinations of dimensions in a multi-level report.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.

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

---

Property	Description
AuthScheme	Specifies the authentication scheme the provider uses to connect.
GlobalCompanyId	Specifies the Global Company ID tied to your Adobe Analytics account.
RSID	Specifies the Report Suite ID (RSID) associated with the Adobe Analytics data you want to query.

Specifies the authentication scheme the provider uses to connect.

Possible Values

OAuth, OAuthClient

Data Type

string

Default Value

"OAuth"

Remarks

• OAuth: Uses OAuth authentication using a standard user account.
• OAuthClient: Uses OAuth authentication using an OAuth service account. (Server-to-Server)

Specifies the Global Company ID tied to your Adobe Analytics account.

Data Type

string

Default Value

""

Remarks

The Global Company ID is a unique identifier assigned to your Adobe Analytics organization. This value distinguishes your organization from others in Adobe’s system and is required for making authenticated API requests. If this property is not set, the provider attempts to detect the first available company ID tied to your account automatically.

Specifies the Report Suite ID (RSID) associated with the Adobe Analytics data you want to query.

Data Type

string

Default Value

""

Remarks

The Report Suite ID identifies the specific set of Adobe Analytics data you want to access.

You can find your RSID on the Adobe Analytics platform by navigating to Admin > Report Suites.

If this property is not set, the Cloud attempts to detect the first available RSID tied to your account automatically.

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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

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.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

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

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

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

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

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

---

Property	Description
IncludeSummaryData	Specifies whether to include summary records in the data returned from custom reports.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Adobe Analytics.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SkipEmptyRows	Specifies whether the provider skips empty rows in the output when querying report data.
SupportEnhancedBreakDown	Specifies whether the provider uses a breadth-first strategy to retrieve rows for all combinations of dimensions in a multi-level report.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.

Specifies whether to include summary records in the data returned from custom reports.

Data Type

bool

Default Value

false

Remarks

This property determines whether the Cloud includes summary records in the output of custom reports.

If this property is set to true, the Cloud includes aggregate values such as totals and averages that summarize the main report data.

If this property is set to false, the Cloud excludes summary records and only includes raw report rows.

Use this property when summary-level insights are relevant to your analysis or reporting needs.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.