Adobe Analytics Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Adobe Analytics Version Support

The connector leverages the Adobe Analytics API v2.0 to enable access to Adobe Analytics objects, such as dimensions, metrics, and users.

Establish a Connection

Connect to Adobe Analytics

To connect to Adobe Analytics, both the GlobalCompanyId and RSID must be identified. By default, the connector 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 connector 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.

Authenticate 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.

Desktop Applications

An embedded OAuth application is provided that simplifies OAuth desktop authentication. Alternatively, you can create a custom OAuth application. Review Creating a Custom OAuth App for more information.

Get and Refresh the OAuth Access Token

Set the following properties to connect:

• InitiateOAuth: Set to GETANDREFRESH to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId (custom applications only): Set to the client ID assigned when you registered your app.
• OAuthClientSecret (custom applications only): Set to the client secret assigned when you registered your app.
• CallbackURL (custom application only): Set to the redirect URI defined when you registered your app. For example: https://localhost:3333

When you connect, the connector opens Adobe Analytics's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. The connector obtains an access token from Adobe Analytics and uses it to request data.
2. The OAuth values are saved in the location specified in OAuthSettingsLocation, to persist across connections.

The connector refreshes the access token automatically when it expires.

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:

• InitiateOAuth: Set to GETANDREFRESH.
• OAuthClientId: Set to the client ID in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.

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

1. Retrieves an access token by using the provided OAuthClientId and OAuthClientSecret in a Client Credentials OAuth flow.
2. Saves OAuth values in OAuthSettingsLocation to persist across connections.
3. Requests new access token when the token expires.

Create a Custom OAuth App

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.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Adobe Analytics connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

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

For further information, see Query Processing.

Log

For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

User Defined Views

The Adobe Analytics connector supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

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

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

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

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

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector 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.

Data Model

The Adobe Analytics connector 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:

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

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.

Adobe Analytics Connector Views

CalculatedMetrics

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

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

CollectionSuites

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

Columns

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.

Columns

KeyMetrics

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

LastTouchChannel

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

LastTouchChannelDetail

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

Metrics

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

Columns

Orders

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

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.

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

Pages

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

PageViews

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

Products

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

Revenue

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

Segments

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

Columns

SiteSections

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

TrackingCode

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

Units

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

UniversalReport

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

Users

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

Columns

Visitors

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

Visits

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

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector 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.

Adobe Analytics Connector Stored Procedures

CreateReport

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

Stored Procedure Specific Information

To create a report view on a query, you can use the CreateReport stored procedure. The CreateReport stored procedure provides an easy way to generate new view definitions with a custom combination of Dimensions and Metrics. Calling it will create 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. You will need to set the Location connection property to the folder containing the new script files in order to access them; the Location can be set instead of the output folder.
You can get the metric/dimension Ids by querying Metrics/Dimensions views.

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

To add calculated metrics you can find the metric ID with:

SELECT Id,Name FROM CalculatedMetrics

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 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'

Dimensions and Metrics should have their respective Ids specified in DimensionIds and MetricIds inputs.

Input

Result Set Columns

GetOAuthAccessToken

Initiate the OAuth 2.0 flow and return a valid access token for use in Adobe Analytics API queries.

Input

Result Set Columns

GetOAuthAuthorizationURL

Return the URL where users can grant your application access to their Adobe Analytics data. Primarily used in web app integrations.

Input

Result Set Columns

RefreshOAuthAccessToken

Since Adobe Analytics does not support refresh tokens, this procedure re-initiates the OAuth flow by calling GetOAuthAccessToken.

Input

Result Set Columns

Reporting Views

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')

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'

System Tables

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 connector 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.

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

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

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

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

Pseudo-Columns

sys_keycolumns

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

sys_foreignkeys

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

sys_primarykeys

Describes the primary keys.

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

SELECT * FROM sys_primarykeys

Columns

sys_indexes

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

sys_connection_props

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

sys_sqlinfo

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

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.