Public Adobe Analytics 2.0 API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefixes in their names.

CreateProcedureForMetrics

Creates a new procedure to parse the specified metrics as columns for the specified metrics container
Parameter
<metricContainer> (required): The metrics block to submit to Adobe Analytics API
<executeStatements> (optional):

Attribute	Type
procedureCode	clob

Dimensions

Dimensions for a given report suite or the specified dimension
Parameter
<rsid> (required): Report Suite ID
<dimensionId> (optional): The dimension ID. For example a valid id is a value like 'evar1' (to return a single dimension)
<locale> (optional): Locale
<segmentable> (optional): Only include dimensions that are valid within a segment
<reportable> (optional): Only include dimensions that are valid within a report
<classifiable> (optional): Only include classifiable dimensions
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
id	string
title	string
name	string
type	string
category	string
support	string
pathable	boolean
segmentable	boolean
reportable	string
supportsDataGovernance	boolean
dataGroup	string
tags	string

Example

SQL

CREATE VIEW adobe_analytics_examples.example_Dimensions AS
	SELECT * FROM (
		CALL adobe_analytics.Dimensions (
			rsid => 'cpttemplatelon',
			locale => 'en_US',
			preview => TRUE
		)
	)x

Discovery

Accessible global company IDs
Parameter
<label> (optional): Multi-tenancy label

Attribute	Type
imsUserId	string
imsOrgId	string
globalCompanyId	string
companyName	string
apiRateLimitPolicy	string

Metrics

Metrics for the given report suite or the specified metric
Parameter
<rsid> (required): ID of desired report suite ie. sistr2
<id> (optional): The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews
<locale> (optional): Locale that system named metrics should be returned in
<segmentable> (optional): Filter the metrics by if they are valid in a segment
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
id	string
title	string
name	string
type	string
extraTitleInfo	string
category	string
support	string
allocation	boolean
precision	integer
calculated	boolean
segmentable	boolean
description	string
polarity	string
helpLink	string
tags	string

Example

SQL

CREATE VIEW adobe_analytics_examples.example_Metrics AS
	SELECT * FROM (
		CALL adobe_analytics.Metrics (
			rsid => 'cpttemplatelon',
			locale => 'en_US',
			preview => TRUE
		)
	)x

ReportSuites

Report suites
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	Id
rsid	string	Report suite Id
name	string	Report suite name