definitions.md

Definitions

AdCloudConfiguration

Name	Schema
cidUrlParam optional	string
dataSourcesId optional	integer (int32)
secondaryRel optional	integer (int32)

AlternateVariableNames

Name	Schema
baseName optional	string
curatedName optional	string
name optional	string

AnalyticsCalculatedMetric

Name	Description	Schema
approved optional		boolean
authorization optional		CalculatedMetricAuthorization
created optional read-only	Calculated metric creation date	string (date-time)
definition required	Calculated metric definition object	CalculatedMetricDef
description optional		string
favorite optional		boolean
id optional read-only	System generated id	string
isDeleted optional		boolean
modified optional		string (date-time)
name optional		string
owner optional		Owner
polarity optional	Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive	enum (positive, negative)
precision optional	Number of decimal places to include in calculated metric result	integer (int32)
reportSuiteName optional read-only	The report suite name for which the component was created/updated	string
rsid optional	The report suite id for which the component was created/updated	string
shares optional		< Share > array
siteTitle optional		string
tags optional		< Tag > array
template optional		boolean
type optional		enum (CURRENCY, TIME, DECIMAL, PERCENT)
usageSummary optional		SummarizedUsageItem
warning optional		MetricsWarning

AnalyticsClassificationColumn

Name	Description	Schema
classifiedBy optional	An optional classification dataset id, whose dataset classifies this column's data.	string
displayName required	The display name for this given data column. Mutable. Can be any valid UTF-8 string.	string
id optional read-only	A UUID that will be generated when a column is created.	string
identityName optional		string
name required	The name for this given data column. Immutable after column creation. Can be any valid UTF-8 string.	string
numericId optional		string
tags optional	Internal column tags. Used to store info (like div nums) to support taxonomist migration.	< string > array
type optional	Defaults to 'text'. Immutable after column creation.	enum (text, integer, float, list[string])

AnalyticsCuratedComponent

Name	Schema
componentId required	string
componentType optional	string
curatedName optional	string

AnalyticsDataGovernanceLabels

Name	Schema
allowedEmpty optional	boolean
defaultLabels optional	< string > array
editable optional	boolean
labels optional	< string > array
usesDefault optional	boolean

AnalyticsDataGovernanceSettings

Name	Schema
auth optional	AnalyticsDataGovernanceLabels
gdprAccess optional	AnalyticsDataGovernanceLabels
gdprDelete optional	AnalyticsDataGovernanceLabels
identifiability optional	AnalyticsDataGovernanceLabels
namespace optional	string
sensitivity optional	AnalyticsDataGovernanceLabels

AnalyticsDimension

Name	Schema
aliasId optional	string
alternateVariableNames optional	AlternateVariableNames
approved optional	boolean
attributes optional	< string > array
attributionModel optional	< string, object > map
breakdownAttributionModel optional	< string, object > map
category optional	string
curatedItem optional	boolean
customerJourney optional	boolean
dataGovernance optional	AnalyticsDataGovernanceSettings
dataGroup optional	string
description optional	string
extraTitleInfo optional	string
favorite optional	boolean
fragRelId optional	string
hidden optional	boolean
id optional	string
isEntryOrExit optional	boolean
name optional	string
noAccess optional	boolean
parent optional	string
pathable optional	boolean
reportTimeAttribution optional	boolean
reportable optional	< string > array
segmentable optional	boolean
shares optional	< Share > array
support optional	< string > array
supportsDataGovernance optional	boolean
tags optional	< Tag > array
title optional	string
type optional	enum (STRING, INT, DECIMAL, CURRENCY, PERCENT, TIME, ENUM, ORDERED_ENUM)
usageSummary optional	SummarizedUsageItem

AnalyticsMcAssociation

Name	Schema
createTimestamp optional	string (date-time)
createUser optional	string
createdBySystem optional	boolean
dataCenter optional	string
dataSourceId optional	integer (int32)
imsOrgId optional	string
partnerId optional	integer (int32)
rsid optional	string
updateTimestamp optional	string (date-time)

AnalyticsMcAudiences

Name	Schema
enabled optional	boolean

AnalyticsMcClusterConfiguration

Name	Description	Schema
dataSourceId optional	the dpid	string

AnalyticsMcEstimatedClusters

Name	Schema
coopEnabled optional	boolean
estimatedPeople optional	AnalyticsMcClusterConfiguration
mcAssociation optional	AnalyticsMcAssociation
rsid optional	string

AnalyticsMetric

Name	Schema
aliasId optional	string
allocation optional	boolean
alternateVariableNames optional	AlternateVariableNames
approved optional	boolean
attributes optional	< string > array
calculated optional	boolean
category optional	string
curatedItem optional	boolean
customerJourney optional	boolean
dataCollectionType optional	string
dataGovernance optional	AnalyticsDataGovernanceSettings
dataGroup optional	string
description optional	string
extraTitleInfo optional	string
favorite optional	boolean
helpLink optional	string
hidden optional	boolean
id optional	string
metricViews optional	< AnalyticsMetricView > array
name optional	string
noAccess optional	boolean
polarity optional	enum (positive, negative)
precision optional	integer (int32)
reportTimeAttribution optional	boolean
segmentable optional	boolean
shares optional	< Share > array
support optional	< string > array
supportsDataGovernance optional	boolean
tags optional	< Tag > array
title optional	string
type optional	enum (STRING, INT, DECIMAL, CURRENCY, PERCENT, TIME, ENUM, ORDERED_ENUM)
usageSummary optional	SummarizedUsageItem
visibility optional	enum (visibleEverywhere, builderOnly, hiddenEverywhere)
warning optional	MetricsWarning

AnalyticsMetricView

Name	Schema
description optional	string
id optional	string
name optional	string

AnalyticsReportSuite

Name	Description	Schema
active optional		boolean
baseUrl optional		string
calendarAnchorDate optional		string (date-time)
calendarType optional		CalendarType
companyId optional		integer (int32)
currency optional		string
currentTimezoneOffset optional		number (float)
dataCurrentAsOf optional		string (date-time)
defaultPage optional		string
ipObfuscationEnabled optional		boolean
isBlocked optional		boolean
isDeleted optional		boolean
lastModified optional		string (date-time)
localizationEnabled optional		boolean
numGroups optional		integer (int32)
parentRsid optional	Parent report suite id for virtual report suite	string
relatedCompanies optional		< RelatedCompany > array
reportSuiteName optional	Friendly report suite name	string
rsid optional	report suite id	string
signedUpDate optional		string (date-time)
timezone optional		integer (int32)
timezoneZoneinfo optional	Suite friendly timezone name	string

AnalyticsReportSuiteDataRetentionSettings

Name	Schema
fragKeyMonths optional	integer (int32)
fragMonths optional	integer (int32)
fragNonKeyMonths optional	integer (int32)
fragSubRelMonths optional	integer (int32)
getdWMonths optional	integer (int32)
retentionMessage optional	string
retentionStatus optional	string

AnalyticsSegmentResponseItem

Name	Description	Schema
aamStatus optional	AAM/Raven publishing status (cross-product segment sharing). A segment can be published to AAM, and this flag indicates whether the segment has been published to AAM.	< string, object > map
alternateVariableNames optional		AlternateVariableNames
approved optional	Whether or not the segment has been marked approved.	boolean
asiInUse optional	Whether or not the segment currently in use in an ASI (old version of VSR) slot.	boolean
compatibility optional	Analytics products that the segment is compatible with	< string, object > map
created optional		string (date-time)
curatedItem optional		boolean
customerJourney optional		boolean
dataGroup optional	The data group of the segment	string
definition optional	The segment definition as a JSON object	< string, object > map
description optional	A description of the segment.	string
dwInUse optional	Whether or not the segment currently in use in a Data Warehouse request. A Data Warehouse request is another type of report that clients can run based on their raw data	boolean
favorite optional	Whether or not the segment has been marked as a favorite.	boolean
id optional	Id of the segment.	string
isDeleted optional	Whether or not the segment is 'Deleted' (deleted segments are only returned if requested by id)	boolean
legacyId optional	Legacy segment id from old segment database (only exists if the segment was migrated from the old segment DB)	string
modified optional		string (date-time)
name optional	A name for the segment.	string
organization optional		string
owner optional	The owner of the segment as an Owner object.	Owner
reportSuiteName optional	The friendly name for the report suite id.	string
reportTimeAttribution optional		boolean
rsid optional	The report suite id.	string
shares optional	Existing shares for the segment.	< Share > array
siteTitle optional	A name for the report suite. This is deprecated and should use the report suite name instead.	string
tags optional	All existing tags associated with the segment.	< Tag > array
template optional	Whether or not the segment is a template. A template is a predefined segment that can be used by all customers and can not be edited	boolean
usageSummary optional	How frequently the user uses this segment.	SummarizedUsageItem
version optional		string
virtualReportSuites optional	A list of all Virtual Report Suites that are using this segment.	< AnalyticsVirtualReportSuite > array

AnalyticsTrackingServer

Name	Description	Schema
trackingServer optional	The server to which a company's tracking data is sent	string

AnalyticsVRSCompatibility

Name	Schema
message optional	string
supported_products optional	< string > array
valid optional	boolean
validator_version optional	string

AnalyticsVirtualReportSuite

Name	Description	Schema
alternateVariableNames optional		AlternateVariableNames
approved optional		boolean
axleConfig optional		ReportSuiteAxleConfig
calendarType optional		CalendarType
compatibility optional		AnalyticsVRSCompatibility
created optional		string (date-time)
curatedComponents optional		< AnalyticsCuratedComponent > array
curationEnabled optional		boolean
currency optional		string
currentTimezoneOffset optional		number (float)
darkSessionsEnabled optional		boolean
dataCurrentAsOf optional		string (date-time)
dataSchema optional		string
description optional		string
discoverUiEnabled optional		boolean
enabledSolutions optional		< string > array
favorite optional		boolean
globalCompanyKey optional		string
groups optional		< UserGroup > array
id optional	System generated virtual report suite id	string
isBlocked optional		boolean
isDeleted optional		boolean
modified optional		string (date-time)
name optional		string
numGroups optional		integer (int32)
numericRsid optional		integer (int32)
owner optional		Owner
parentRsid optional	Parent report suite id for virtual report suite	string
parentRsidName optional	Parent report suite name	string
remoteLoading optional		boolean
reportSuiteName optional read-only	The report suite name for which the component was created/updated	string
rsid optional	The report suite id for which the component was created/updated	string
segmentList optional	List of segments applied to this virtual report suite	< string > array
sessionDefinition optional		JsonNode
shares optional		< Share > array
siteTitle optional		string
tags optional		< Tag > array
taxonomist optional		boolean
timezone optional		integer (int32)
timezoneZoneinfo optional	Suite friendly timezone name	string
usageSummary optional		SummarizedUsageItem

Approval

Name	Description	Schema
approvalId optional read-only	A system generated approval id	integer (int64)
approvalTimestamp optional read-only	The timestamp for when this approval was last updated	string (date-time)
companyId required	The Analytics company id for which this approval was created	integer (int32)
componentId required	The id of the component for which to create an approval	string
componentType required	The component type	enum (segment, dashboard, bookmark, calculatedMetric, project, dateRange, metric, dimension, virtualReportSuite, scheduledJob, alert, classificationSet)
componentTypeId optional	The component type id which is determined by the componentType	integer (int32)
userId required	The Analytics user id of the user that created this approval	integer (int32)

AttributionModel

Name	Schema
context optional	string
expiration optional	ExpirationSettings
firstWeight optional	integer (int32)
func optional	enum (ALLOCATION_FIRST_TOUCH, ALLOCATION_LAST_TOUCH, ALLOCATION_INSTANCE, ALLOCATION_LAST_KNOWN, ALLOCATION_LEGACY, ALLOCATION_LINEAR, ALLOCATION_PARTICIPATION, ALLOCATION_POSITION_BASED, ALLOCATION_TIME_DECAY, ALLOCATION_U_SHAPED, ALLOCATION_J_SHAPED, ALLOCATION_REVERSE_J_SHAPED)
halfLifeGranularity optional	string
halfLifeNumPeriods optional	integer (int32)
lastWeight optional	integer (int32)
merchandising optional	MerchandisingSettings
middleWeight optional	integer (int32)

BatchDataGovernanceSettings

Name	Schema
auth optional	AnalyticsDataGovernanceLabels
gdprAccess optional	AnalyticsDataGovernanceLabels
gdprDelete optional	AnalyticsDataGovernanceLabels
identifiability optional	AnalyticsDataGovernanceLabels
namespace optional	string
sensitivity optional	AnalyticsDataGovernanceLabels
status optional	DataGovernanceBatchOperationStatus
variableId optional	string

CalcMetricCompatibility

Name	Schema
functions optional	< string > array
identityDimensions optional	< string > array
identityMetrics optional	< IdentityMetric > array
message optional	string
segments optional	< string > array
supported_products optional	< string > array
supported_schema optional	< string > array
valid optional	boolean
validator_version optional	string

CalcMetricFunction

Name	Schema
category optional	string
definition optional	CalcMetricFunctionDef
description optional	string
example optional	string
exampleKey optional	string
id optional	string
name optional	string
namespace optional	string
persistable optional	boolean

CalcMetricFunctionDef

Name	Schema
formula optional	< string, object > map
func optional	string
parameters optional	< CalcMetricFunctionParameter > array
version optional	< integer (int32) > array

CalcMetricFunctionParameter

Name	Schema
default-value optional	object
descKey optional	string
description optional	string
friendlyName optional	string
friendlyNameKey optional	string
func optional	string
name optional	string
type optional	string

CalculatedMetricAuthorization

Name	Schema
authorized optional	boolean
unAuthorizedMetricIdentities optional	< string > array
unAuthorizedSegmentIds optional	< string > array

CalculatedMetricDef

Type : object

CalculatedMetricErrorStatus

Name	Schema
errorCode optional	enum (no_feature_access_to_advanced_calculated_metrics, invalid_metric_access, method_not_allowed, resource_conflict, invalid_access, resource_temporarily_unavailable, external_api_failure, resource_already_exists, invalid_state, invalid_json_input, invalid_parameters, invalid_dimension_access, unsupported_data_type, resource_not_found, insufficient_access, health_check_error, invalid_data, unexpected_error, external_api_error, unsupported_resource, io_error, invalid_request, invalid_client_id, unauthorized, authorization_error, invalid_token, insufficient_scope)
errorDescription optional	string
errorDetails optional	< string, object > map
errorId optional	string

CalendarType

Name	Schema
anchorDate optional	string (date-time)
rsid optional	string
type optional	enum (gregorian, nrf, qrs, custom_454, custom_445, modified_gregorian)

ClassificationJob

Name	Description	Schema
datasetId optional		string
history optional		< JobHistory > array
imsOrgId optional		string
jobId optional		string
jobOptions optional	see POST /classifications/dataset/{id}/jobs/import and POST /classifications/dataset/{id}/jobs/export for details on this data model	object
jobSize optional		integer (int64)
name optional		string
setName optional		string
state optional		string
totalLines optional		integer (int32)
type optional		string

ClassificationOwner

Name	Schema
email optional	string
name optional	string

ClassificationSet

Name	Description	Schema
columns optional	A list of classification column definitions. Column definitions are not required at the time of creation but no data will be classified until at least one column definition exists.	< AnalyticsClassificationColumn > array
defaultEncoding optional	Default encoding for jobs. Defaults to UTF-8.	enum (utf8, latin1)
defaultListDelimiter optional	Default delimiter for list column types. Defaults to "," (comma). If you have no list columns this field does not apply.	string
description optional	A long description for the purpose of this classification set.	string
editable optional read-only	Flag to indicate if the classification set is editable by the current user based on report suite permissions.	boolean
ftpSettings optional	Ftp settings for the classification set.	FtpSettings
id optional read-only	This value will be auto generated by the system on creation. This value will be a id in the form of an ObjectId.	string
imsOrgId optional read-only	This value will be looked up based on the analytics company of the user.	string
lastModifiedBy optional	Email address of the last person that modified the classification set.	string
lastModifiedDate optional	Last modified date/time of the classification set.	string
name required	A human readable display name for users to be able to easily identify this classification definition.	string
notifications optional	List of notifications to be sent for all imports and exports that occur.	< Notification > array
owner optional	Contact information for a person responsible for the classification definition and/or data.	ClassificationOwner
ruleInitialLookback optional		integer (int32)
ruleMode optional		string
ruleState optional		string
ruleTestKeys optional		< string > array
subscriptions optional	A list of classification subscriptions. Subscriptions are not required at the time of creation but no data will be classified until at least one subscription exists.	< ClassificationSubscription > array
tags optional		< Tag > array
type optional		enum (standard, lookup)

ClassificationSetFilterArgs

Name	Schema
dimensions optional	< string > array
ids optional	< string > array
rsids optional	< string > array
tagNames optional	string
type optional	enum (standard, lookup)

ClassificationSubscription

Name	Description	Schema
dimension required	The dimension identity you would like to be classified. Should be prefixed with variables/ i.e. variables/page	string
editable optional read-only	Flag to indicate if the subscription is editable by the current user based on report suite permissions.	boolean
rsid required	The report suite id for which you would like to subscribe to a classification set.	string

Column

Name	Schema
id optional	string
segmentIds optional	< string > array
title optional	string
type optional	enum (DIMENSION, METRIC)

Company

Name	Description	Schema
accessType optional		enum (pointProducts, standard, premium, mobile, premiumPredictive, premiumAttribution, premiumCustomer, core, essentialsDps, foundation, select, prime, ultimate)
adminLogin optional	Login of the main user responsible for the login company	string
allowAdobeEmails optional		boolean
apiRateLimitPolicy optional		string
billingCustomerId required	Id for the company that is used by the billing system	integer (int64)
billingTabAccess optional		boolean
companyPrefix optional		string
companySecurity optional		CompanySecurity
companyid optional		integer (int32)
description required		string
disabled optional		boolean
featureAccessOverrides optional		< string, < string, string > map > map
globalCompanyKey required	System generated cross data-center unique company id	string
imsOrgid required	Id of the IMS Organization that owns the company	string
name required		string
namespace required	System generated namespace	string
permissionAuthority optional		enum (ims, both)
validEmails optional	List of allowed email address domains for users in the company	< string > array

CompanySecurity

Name	Schema
emailRestrictions optional	boolean
ipRestrictions optional	boolean
passwordExpiration optional	boolean
passwordRecovery optional	boolean
strongPasswords optional	boolean

CustomReportSuiteFilterGroup

Name	Schema
customGroupId optional	integer (int32)
customGroupName optional	string

DataGovernanceBatchOperationStatus

Name	Schema
error optional	ErrorStatus
success optional	boolean
variableIdSavedAs optional	string
variableIdTranslationMessage optional	string

DeleteResponse

Name	Schema
message optional	string
result optional	string

DimensionItem

Name	Schema
dimension optional	string
itemId optional	string
value optional	string

ErrorStatus

Name	Schema
errorCode optional	enum (invalid_metric_access, method_not_allowed, resource_conflict, invalid_access, resource_temporarily_unavailable, external_api_failure, resource_already_exists, invalid_state, invalid_json_input, invalid_parameters, invalid_dimension_access, unsupported_data_type, resource_not_found, insufficient_access, health_check_error, invalid_data, unexpected_error, external_api_error, unsupported_resource, io_error, invalid_request, invalid_client_id, unauthorized, authorization_error, invalid_token, insufficient_scope)
errorDescription optional	string
errorDetails optional	< string, object > map
errorId optional	string

ExpirationSettings

Name	Schema
context optional	string
events optional	< string > array
func optional	enum (afterEvents, beforeEvents, inactivity, container)
granularity optional	string
numPeriods optional	integer (int32)

Favorite

Name	Schema
companyId optional	integer (int32)
componentId optional	string
componentType optional	string
componentTypeId optional	integer (int32)
favoriteId optional	integer (int64)
favoriteTimestamp optional	string (date-time)
userId optional	integer (int32)

FtpSettings

Name	Schema
hostName optional	string
password optional	string
userName optional	string

IdentityMetric

Name	Schema
allocationModel optional	enum (ALLOCATION_FIRST_TOUCH, ALLOCATION_LAST_TOUCH, ALLOCATION_INSTANCE, ALLOCATION_LAST_KNOWN, ALLOCATION_LEGACY, ALLOCATION_LINEAR, ALLOCATION_PARTICIPATION, ALLOCATION_POSITION_BASED, ALLOCATION_TIME_DECAY, ALLOCATION_U_SHAPED, ALLOCATION_J_SHAPED, ALLOCATION_REVERSE_J_SHAPED)
dimensionView optional	enum (LINEAR_ALLOCATION, PARTICIPATION_ALLOCATION, LAST_TOUCH_ALLOCATION, MC_FIRST_TOUCH_ALLOCATION, MC_LAST_TOUCH_ALLOCATION)
identity optional	string

ImsOrgIdsFromRelatedCompanies

Name	Schema
owningImsOrgId optional	string
relatedImsOrgIds optional	< string > array

JSONObject

Type : object

JobArtifactResponse

Name	Schema
artifactId optional	string
fileType optional	string
lastModifiedTime optional	string

JobExportOptions

Name	Schema
columns optional	< string > array
dataFormat optional	string
dataUri optional	string
dateFilterEnd optional	string
dateFilterStart optional	string
encoding optional	string
exactMatch optional	< string, object > map
jobName optional	string
keyRegex optional	string
keys optional	< string > array
listDelimiter optional	string
notifications optional	< Notification > array
offset optional	integer (int32)
regexMatch optional	< string, object > map
rowLimit optional	integer (int32)
source optional	string

JobHistory

Name	Schema
host optional	string
jobState optional	enum (created, queued, validated, failed_validation, processing, done_processing, failed_processing, completed)
message optional	string
pid optional	integer (int32)
tag optional	string
timestamp optional	integer (int64)

JobImportOptions

Name	Schema
dataFormat optional	string
dataUri optional	string
encoding optional	string
jobName optional	string
listDelimiter optional	string
notifications optional	< Notification > array
source optional	string

JsonNode

Name	Schema
array optional	boolean
bigDecimal optional	boolean
bigInteger optional	boolean
binary optional	boolean
boolean optional	boolean
containerNode optional	boolean
double optional	boolean
float optional	boolean
floatingPointNumber optional	boolean
int optional	boolean
integralNumber optional	boolean
long optional	boolean
missingNode optional	boolean
nodeType optional	enum (ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING)
null optional	boolean
number optional	boolean
object optional	boolean
pojo optional	boolean
short optional	boolean
textual optional	boolean
valueNode optional	boolean

Locale

Name	Schema
country optional	string
displayCountry optional	string
displayLanguage optional	string
displayName optional	string
displayScript optional	string
displayVariant optional	string
extensionKeys optional	< string > array
iso3Country optional	string
iso3Language optional	string
language optional	string
script optional	string
unicodeLocaleAttributes optional	< string > array
unicodeLocaleKeys optional	< string > array
variant optional	string

MerchandisingBindingCriteria

Name	Schema
bindingEvents optional	< string > array
func optional	enum (always, events)

MerchandisingSettings

Name	Schema
bindingCriteria optional	MerchandisingBindingCriteria
func optional	enum (nonMerchandising, forced, auto)

MetricsWarning

Name	Schema
helpLink optional	string
text optional	string
title optional	string

Notification

Name	Schema
method optional	enum (email, rabbit)
recipients optional	< string > array
state optional	enum (created, queued, validated, failed_validation, processing, done_processing, failed_processing, completed)

Owner

Name	Description	Schema
id required	the login id of the owner	integer (int32)
login optional	the friendly full login name of the owner, included when the expansion parameter ownerFullName is true	string
name optional	the friendly full login name of the owner, included when the expansion parameter ownerFullName is true	string

Pageable

Name	Schema
offset optional	integer (int32)
pageNumber optional	integer (int32)
pageSize optional	integer (int32)
sort optional	Sort

PredictiveSettings

Name	Schema
highAnomalies optional	boolean
lowAnomalies optional	boolean
trainingPeriods optional	integer (int32)

RankedColumnError

Name	Schema
columnId optional	string
errorCode optional	enum (unauthorized_metric, unauthorized_dimension, unauthorized_dimension_global, anomaly_detection_failure_unexpected_item_count, anomaly_detection_failure_tsa_service, not_enabled_metric, not_enabled_dimension, not_enabled_dimension_global)
errorDescription optional	string
errorId optional	string

RankedColumnMetaData

Name	Schema
columnErrors optional	< RankedColumnError > array
columnIds optional	< string > array
dimension optional	ReportDimension

RankedReportData

Name	Schema
columns optional	RankedColumnMetaData
firstPage optional	boolean
lastPage optional	boolean
message optional	string
number optional	integer (int32)
numberOfElements optional	integer (int32)
oberonRequestXML optional	< string > array
oberonResponseXML optional	< string > array
predictiveRequestObjects optional	< string > array
predictiveResponseObjects optional	< string > array
reportId optional	string
request optional	RankedRequest
rows optional	< Row > array
summaryData optional	RankedSummaryData
totalElements optional	integer (int32)
totalPages optional	integer (int32)

RankedRequest

Name	Schema
anchorDate optional	string
dimension optional	string
globalFilters optional	< ReportFilter > array
globalPredictiveSettings optional	PredictiveSettings
locale optional	Locale
metricContainer optional	ReportMetrics
rowContainer optional	ReportRows
rsid optional	string
search optional	ReportSearch
settings optional	RankedSettings
statistics optional	RankedStatistics

RankedSettings

Name	Schema
countRepeatInstances optional	boolean
darkSessionsEnabled optional	boolean
dataSchema optional	string
dimensionSort optional	string
includeAnomalyDetection optional	boolean
includeLatLong optional	boolean
includePercentChange optional	boolean
limit optional	integer (int32)
page optional	integer (int32)
reflectRequest optional	boolean
sessionExpiration optional	< SessionExpirationSettings > array
suiteReportingContext optional	enum (DEVICE, TROMMEL_COMBINED)

RankedStatistics

Name	Schema
functions optional	< string > array
ignoreZeroes optional	boolean

RankedSummaryData

Type : object

RelatedCompany

Name	Schema
companyId optional	integer (int32)
name optional	string

ReportDimension

Name	Schema
id optional	string
type optional	enum (STRING, INT, DECIMAL, CURRENCY, PERCENT, TIME, ENUM, ORDERED_ENUM)

ReportErrorStatus

Name	Schema
errorCode optional	enum (invalid_segment_ids_found, invalid_metric_access, method_not_allowed, resource_conflict, invalid_access, resource_temporarily_unavailable, external_api_failure, resource_already_exists, invalid_state, invalid_json_input, invalid_parameters, invalid_dimension_access, unsupported_data_type, resource_not_found, insufficient_access, health_check_error, invalid_data, unexpected_error, external_api_error, unsupported_resource, io_error, invalid_request, invalid_client_id, unauthorized, authorization_error, invalid_token, insufficient_scope)
errorDescription optional	string
errorDetails optional	< string, object > map
errorId optional	string

ReportFilter

Name	Schema
allocationModel optional	AttributionModel
dateRange optional	string
dimension optional	string
excludeItemIds optional	< integer > array
id optional	string
itemId optional	string
itemIds optional	< string > array
segmentDefinition optional	< string, object > map
segmentId optional	string
type optional	enum (DATE_RANGE, BREAKDOWN, SEGMENT, EXCLUDE_ITEM_IDS)

ReportMetric

Name	Schema
allocationModel optional	AttributionModel
allocationType optional	string
columnId optional	string
filters optional	< string > array
id optional	string
metricDefinition optional	< string, object > map
metricView optional	string
predictive optional	ReportMetricPredictiveSettings
sort optional	string

ReportMetricPredictiveSettings

Name	Schema
anomalyConfidence optional	number (double)

ReportMetrics

Name	Schema
metricFilters optional	< ReportFilter > array
metrics optional	< ReportMetric > array

ReportRow

Name	Schema
filters optional	< string > array
rowId optional	string

ReportRows

Name	Schema
rowFilters optional	< ReportFilter > array
rows optional	< ReportRow > array

ReportSearch

Name	Schema
clause optional	string
empty optional	boolean
excludeItemIds optional	< integer > array
includeSearchTotal optional	boolean
itemIds optional	< integer > array

ReportSuiteAxleConfig

Name	Schema
axleData optional	boolean
axleStart optional	string

ReportSuiteHateoasReferences

Name	Schema
billingCustomerUrl optional	string
companyUrl optional	string

Row

Name	Schema
data optional	< number (double) > array
dataAnomalyDetected optional	< boolean > array
dataExpected optional	< number (double) > array
dataLowerBound optional	< number (double) > array
dataUpperBound optional	< number (double) > array
itemId optional	string
latitude optional	number (double)
longitude optional	number (double)
percentChange optional	< number (double) > array
rowId optional	string
value optional	string

RowItem

Name	Schema
itemId optional	string
value optional	string

SegmentCompatibility

Name	Schema
message optional	string
supported_features optional	< string > array
supported_products optional	< string > array
supported_schema optional	< string > array
valid optional	boolean
validator_version optional	string

SegmentPublishingConfig

Name	Schema
dataSourceId optional	integer (int32)
segmentFolderId optional	integer (int32)
traitFolderId optional	integer (int32)

SegmentSummaryResponse

Name	Schema
compatibility optional	< string > array
detailMsg optional	string
oberonRequestXml optional	string
oberonResponseXml optional	string
report optional	TotalsReportData
supportedEngines optional	< string > array

SessionExpirationSettings

Name	Schema
containerName optional	string
events optional	< string > array
func optional	enum (afterEvents, inactivity, container, beforeEvents)
granularity optional	string
numPeriods optional	integer (int32)

Share

Name	Schema
componentId required	string
componentType optional	string
shareId optional	integer (int64)
shareToDisplayName optional	string
shareToId required	integer (int64)
shareToLogin optional	string
shareToType required	string

Sort

Type : object

SubscriptionValidationResponse

Name	Schema
dimension optional	string
dimensionName optional	string
errorCode optional	enum (invalid_rsid, dimension_not_classifiable, taxonomist_not_enabled_for_rsid, multiple_subscription_rsids)
rsid optional	string
valid optional	boolean

SuiteCollectionItem

Name	Description	Schema
axleConfig optional		ReportSuiteAxleConfig
calendarType optional		CalendarType
collectionItemType optional	Suite type	enum (reportsuite, virtualreportsuite)
currency optional		string
currentTimezoneOffset optional		number (float)
dataCurrentAsOf optional		string (date-time)
dataSchema optional		string
discoverUiEnabled optional		boolean
enabledSolutions optional		< string > array
isBlocked optional		boolean
isDeleted optional		boolean
name optional		string
numGroups optional		integer (int32)
numericRsid optional		integer (int32)
parentRsid optional	Parent report suite id for virtual report suite	string
remoteLoading optional		boolean
rsid optional read-only		string
taxonomist optional		boolean
timezoneZoneinfo optional	Suite friendly timezone name	string

SummarizedUsageItem

Name	Schema
count optional	integer (int32)
itemId optional	string
mostRecentTimestamp optional	string (date-time)
relevancyScore optional	number (float)

Tag

Tag Model

Name	Description	Schema
components optional	the list of components that have been tagged with this tag	< TaggedComponent > array
description optional	the tag description	string
id optional	the tag id	integer (int32)
name optional	the tag name	string

TaggedComponent

Name	Schema
componentId optional	string
componentType optional	string
tags optional	< Tag > array

Timezone

Name	Schema
id optional	integer (int32)
name optional	string

TntConfig

Name	Schema
tnt optional	boolean
tntA4tDateEnabled optional	boolean
tntAllocationType optional	integer (int32)
tntClientCode optional	string
tntExpirePeriods optional	integer (int32)
tntExpireType optional	integer (int32)

TotalsReportData

Name	Schema
columns optional	< Column > array
message optional	string
reportId optional	string
totals optional	< RowItem > array

UnhashReportData

Name	Schema
firstPage optional	boolean
lastPage optional	boolean
message optional	string
number optional	integer (int32)
numberOfElements optional	integer (int32)
oberonRequestXML optional	string
oberonResponseXML optional	string
reportId optional	string
rows optional	< RowItem > array
searchAnd optional	string
searchNot optional	string
searchOr optional	string
searchPhrase optional	string
totalElements optional	integer (int32)
totalPages optional	integer (int32)

User

Name	Schema
admin optional	boolean
companyid optional	integer (int32)
email optional	string
firstName optional	string
fullName optional	string
imsUserId optional	string
lastName optional	string
login optional	string
loginId optional	integer (int32)

UserGroup

Name	Schema
allRsids optional	boolean
created optional	string (date-time)
description optional	string
groupId optional	integer (int32)
imsPlcId optional	string
imsPlcIdOrphaned optional	boolean
loginIds optional	< integer (int32) > array
modified optional	string (date-time)
name optional	string
oids optional	< integer (int32) > array
rsids optional	< string > array
tokens optional	< string > array