OpenAPI definition

Schemas

AFM

attributesobject[] · required
Attributes to be used in the computation.
filtersobject[] · required
Various filter types to filter the execution result.
measuresobject[] · required
Metrics to be computed.

auxMeasuresobject[]
Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
measureDefinitionOverridesobject[]
(EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.
parametersobject[]
(EXPERIMENTAL) Parameter values to use for this execution.

AbsoluteDateFilter

absoluteDateFilterobject · required

AbsoluteDateFilterBody

datasetobject · required
ObjectIdentifier with identifier wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
fromstring · pattern: ^\d{4}-\d{1,2}-\d{1,… · required
tostring · pattern: ^\d{4}-\d{1,2}-\d{1,… · required

applyOnResult
emptyValueHandling
localIdentifier

AbsoluteGranularityDateFilter

absoluteGranularityDateFilterobject · required

AbstractMeasureValueFilter

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: comparisonMeasureValueFilter
	type = object · requires: rangeMeasureValueFilter
	type = object · requires: compoundMeasureValueFilter
	type = object · requires: rankingFilter

Properties for ComparisonMeasureValueFilter:

Filter the result by comparing specified metric to given constant value, using given comparison operator.

comparisonMeasureValueFilterobject · required

ActiveObjectIdentification

idstring · required
Object ID.
typestring · required
Object type, e.g. dashboard.
workspaceIdstring · required
Workspace ID.

AdHocAutomation

alertobject
analyticalDashboardobject
An analytical dashboard identifier.
dashboardTabularExportsobject[] · unique
descriptionstring · maxLength: 255
detailsobject · maxLength: 10000
Additional details to be included in the automated message.
externalRecipientsobject[] · unique
External recipients of the automation action results.
imageExportsobject[] · unique
metadataobject | null · maxLength: 250000
Additional information for the automation.
notificationChannelobject
A notification channel identifier.
rawExportsobject[] · unique
recipientsobject[] · unique
slidesExportsobject[] · unique
tabularExportsobject[] · unique
tagsstring[] · unique
A list of tags.
Example: ["Revenue","Sales"]
titlestring · maxLength: 255
visualExportsobject[] · unique

AddDatabaseDataSourceRequest

dataSourceIdstring · required
Identifier for the new data source in metadata-api. Must be unique within the organization.

dataSourceNamestring
Display name for the new data source in metadata-api. Defaults to dataSourceId when omitted.

AddDatabaseDataSourceResponse

dataSourceobject · required
A single data source association for an AI Lake Database instance

AfmCancelTokens

resultIdToCancelTokenPairsobject · required
resultId to cancel token pairs

AfmExecution

executionobject · required
Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
resultSpecobject · required
Specifies how the result data will be formatted (dimensions) and which additional data shall be computed (totals).

settingsobject
Various settings affecting the process of AFM execution or its result

AfmExecutionResponse

executionResponseobject · required
Response to AFM execution request body

AfmIdentifier

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: identifier
	type = object · requires: localIdentifier

Properties for AfmObjectIdentifier:

ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.

identifierobject · required

AfmLocalIdentifier

localIdentifierstring · pattern: ^[.a-zA-Z0-9_-]+$ · required
Example: sampleAutoGenerated0123_ID

AfmObjectIdentifier

identifierobject · required

AfmObjectIdentifierAttribute

identifierobject · required

AfmObjectIdentifierBody

idstring · minLength: 1 · maxLength: 255 · required
typestring · required

AfmObjectIdentifierCore

identifierobject · required

AfmObjectIdentifierDataset

identifierobject · required

AfmObjectIdentifierLabel

identifierobject · required

AfmObjectIdentifierParameter

identifierobject · required

AfmValidDescendantsQuery

attributesobject[] · required
List of identifiers of the attributes to get the valid descendants for.

AfmValidDescendantsResponse

validDescendantsobject · required
Map of attribute identifiers to list of valid descendants identifiers.

AfmValidObjectsQuery

afmobject · required
Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
typesstring[] · unique · required
Enum values:
facts
attributes
measures
Example: facts

AfmValidObjectsResponse

itemsobject[] · required

AgentListItemResponse

idstring · required
isAvailableToAllboolean · required
namestring · required

description
lastUsedAt
modifiedAt

AgentListResponse

agentsobject[] · required

AggregateKeyConfig

typestring · enum · required
Enum values:
aggregate

columnsstring[]
Key columns. Defaults to first inferred column.

AiLakeIcebergCatalogConfig

defaultsobject
Configuration defaults the client may override.
overridesobject
Configuration the client must apply (includes the catalog prefix and warehouse).

Additional properties are allowed

AiLakeIcebergCommitTableRequest

requirementsobject[] · required
updatesobject[] · required

identifierobject

Additional properties are allowed

AiLakeIcebergCommitTableResponse

metadataobject
Iceberg table metadata (Apache Iceberg TableMetadata structure).
metadata-locationstring

Additional properties are allowed

AiLakeIcebergCreateTableRequest

namestring · required
Table name.
schemaobject · required
Iceberg schema (Apache Iceberg Schema structure).

partition-specobject
Iceberg partition spec (identity/day/month/bucket/truncate transforms supported).
propertiesobject
Table properties, e.g. format-version, write.format.default.
stage-createboolean
write-orderobject
Iceberg sort order.

Additional properties are allowed

AiLakeIcebergErrorResponse

errorobject

AiLakeIcebergGetNamespaceResponse

namespacestring[]
Namespace levels. AI Lake namespaces are always single-level.
propertiesobject
Namespace properties.

Additional properties are allowed

AiLakeIcebergListTablesResponse

identifiersobject[]
next-page-tokenstring

Additional properties are allowed

AiLakeIcebergLoadTableResult

configobject
metadataobject
Iceberg table metadata (Apache Iceberg TableMetadata structure).
metadata-locationstring

Additional properties are allowed

AiUsageMetadataItem

counterTypestring · required
Type of usage counter, e.g. AI_QUERIES.
currentValueinteger · int64 · required
Current usage value after this request.
limitinteger · int64 · required
Entitlement limit. 0 means unlimited.

AlertAfm

filtersobject[] · required
Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.
measuresobject[] · min: 1 · max: 2 · required
Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.

attributesobject[] · max: 1
Attributes to be used in the computation.
auxMeasuresobject[]
Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
parametersobject[]
Parameters to be used in the computation.

AlertCondition

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: comparison
	type = object · requires: range
	type = object · requires: relative
	type = object · requires: anomaly

Properties for Variant 1:

comparisonobject · required

AlertConditionOperand

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: localIdentifier
	type = object · requires: value

Properties for Variant 1:

localIdentifierstring · required
Local identifier of the metric to be compared.
Example: m1

formatstring | null · maxLength: 2048
Metric format.
Example: #,##0
Default: #,##0.00
titlestring | null · maxLength: 255
Metric title.
Example: Revenue

AlertDatasetIdentifier

idstring · required
Date dataset identifier.

typestring · const
Dataset object type.
Const value: dataset
Default: dataset

AlertDatasetRef

identifierobject · required
Date dataset identifier.

title
Date dataset display title.

AlertDefinition

conditionrequired
Alert trigger condition.
executionobject · required
Execution (AFM) definition of the alert.

interval
Interval granularity for ONCE_PER_INTERVAL triggers.
triggerstring · enum
Trigger behavior.
Enum values:
ALWAYS
ONCE
ONCE_PER_INTERVAL
Default: ALWAYS

AlertDescription

conditionstring · required
metricstring · required

attributestring
currentValuesobject[]
errorMessagestring
formattedThresholdstring
lowerThresholdnumber · double
remainingAlertEvaluationCountinteger · int32
statusstring · enum
Enum values:
SUCCESS
ERROR
INTERNAL_ERROR
TIMEOUT
thresholdnumber · double
totalValueCountinteger · int32
traceIdstring
triggeredAtstring · date-time
triggeredCountinteger · int32
upperThresholdnumber · double

AlertEvaluationRow

computedMetricobject
labelValuestring
primaryMetricobject
secondaryMetricobject

AlertExecution

attributesobject[]
Attribute slicing configuration.
filtersobject[]
Alert execution filters.
measuresobject[]
Metrics computed by the alert (1-2).

AlertProposal

alertobject · required
The alert definition (condition, execution, trigger).
notificationChannelobject · required
Notification channel for delivery.
titlestring · required
Alert title.

automationId
Automation identifier proposed for creation.
ctastring
Confirmation call to action.
Default: Should I create this alert?
dashboard
Dashboard the alert is bound to.
description
Alert description.
forLabel
Human-readable 'For' summary.
forMode
Display mode for the monitored population.
recipientsobject[]
Recipients shown in the proposal.
schedule
Optional cron schedule.

AlertProposalPart

alertProposal
Optional full alert proposal payload when available.
typestring · const
Type of multipart part.
Const value: alertProposal
Default: alertProposal

AlertRecipient

labelstring · required
Recipient display label.

email
External recipient email when available.
id
Internal user identifier when available.

AlertSchedule

cron
Cron expression for the alert schedule.
timezone
Schedule timezone.

AlertTrigger

string · enum

Enum values:

ALWAYS

ONCE

ONCE_PER_INTERVAL

Trigger behavior for the alert.

AllTimeDateFilter

allTimeDateFilterobject · required

AllTimeDateFilter-Input

allTimeDateFilterobject · required

AllTimeDateFilter-Output

allTimeDateFilterobject · required

AllTimeDateFilterBody-Input

datasetobject · required
ObjectIdentifier with identifier wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.

applyOnResult
emptyValueHandling
granularity
localIdentifier

AllTimeDateFilterBody-Output

datasetobject · required
ObjectIdentifier with identifier wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.

applyOnResult
emptyValueHandling
granularity
localIdentifier

AllowedRelationshipType

sourceTypestring · enum · required
Source object type (e.g., 'dashboard', 'visualization', 'metric').
Enum values:
attribute
metric
fact
label
date
dataset
visualization
dashboard
targetTypestring · enum · required
Target object type (e.g., 'visualization', 'metric', 'attribute').
Enum values:
attribute
metric
fact
label
date
dataset
visualization
dashboard

allowOrphansboolean
If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).
Default: true

AmplitudeService

aiProjectApiKeystring · required
API key for AI project - intended for frontend use.
endpointstring · required
Amplitude endpoint URL.
gdCommonApiKeystring · required
API key for GoodData common project - used by backend.

reportingEndpointstring
Optional reporting endpoint for proxying telemetry events.

AnalyticsCatalogCreatedBy

reasoningstring · required
Reserved for future use. Always empty string in the current implementation.
usersobject[] · required
Distinct users who have created at least one catalog object.

AnalyticsCatalogTags

tagsstring[] · required
Sorted, distinct tag strings found in the workspace hierarchy.

AnalyticsCatalogUser

firstnamestring · required
User first name.
Example: John
lastnamestring · required
User last name.
Example: Doe
userIdstring · required
User identifier.
Example: user123

AnalyzeCsvRequest

analyzeRequestsobject[] · required
List of individual CSV analysis requests.

AnalyzeCsvRequestItem

locationstring · required
Location of the CSV file to analyze.

configobject
CSV analysis request config.

AnalyzeCsvRequestItemConfig

delimitersstring[]
Possible column delimiters.
headerDetectMaxRowsinteger · int32
Maximum number of rows to work with during header detection.
headerRowCountinteger · int32
Number of rows to consider as header, if null, header will be detected.
resultRowsinteger · int32
Number of rows to return in the flight that represents analysis result. If 0, no rows are returned, if less than 0, all rows that were in the sample are returned.

AnalyzeCsvResponse

columnsobject[] · required
List of column metadata.
locationstring · required
Location of the analyzed file in the source data source.
previewDataarray[] · required
Preview of the first N rows of the file.

configobject
Config used to process the CSV file.

AnalyzeCsvResponseColumn

namestring · required
Name of the column as specified in the file (or autogenerated one if the file has no header).
typestring · required
Type of the column (e.g. string, bool, etc.).

detectedDateFormatsstring[]
List of date formats that can be used to parse this column as date. Null if there are none.

AnalyzeCsvResponseConfig

convertOptionsobject
Options for converting CSV files when reading.
parseOptionsobject
Options for parsing CSV files.
readOptionsobject
Options for reading CSV files.

AnalyzeStatisticsRequest

tableNamesstring[]
Table names to analyze. If empty or null, all tables in the database are analyzed.

AnomalyCondition

anomalyobject · required
Anomaly detection condition.

AnomalyDetection

datasetobject · required
Date dataset used for anomaly detection.
granularitystring · enum · required
Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
Enum values:
HOUR
DAY
WEEK
MONTH
QUARTER
YEAR
measureobject · required
Metric analyzed for anomalies.
sensitivitystring · enum · required
Sensitivity level for anomaly detection
Enum values:
LOW
MEDIUM
HIGH

AnomalyDetectionConfig

sensitivitystring · enum · required
Outlier sensitivity level.
Enum values:
LOW
MEDIUM
HIGH

AnomalyDetectionGranularity

string · enum

Enum values:

HOUR

DAY

WEEK

MONTH

QUARTER

YEAR

Time-based granularity supported by anomaly detection.

AnomalyDetectionRequest

sensitivitynumber · float · required
Anomaly detection sensitivity.

AnomalyDetectionResult

anomalyFlag(boolean | null)[] · required
attributestring[] · required
values(number | null)[] · required

AnomalyDetectionWrapper

anomalyobject · required

AnthropicApiKeyAuth

typestring · enum · required
Authentication type.
Enum values:
API_KEY

apiKeystring | null · maxLength: 255 · writeOnly
Anthropic API key.

AnthropicProviderAuth

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: type

Properties for Variant 1:

typestring · enum · required
Authentication type.
Enum values:
API_KEY

apiKeystring | null · maxLength: 255 · writeOnly
Anthropic API key.

AnthropicProviderConfig

authobject · required
Authentication configuration.
typestring · enum · required
Provider type.
Enum values:
ANTHROPIC

baseUrlstring · maxLength: 255
Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways.
Default: https://api.anthropic.com

ApiEntitlement

namestring · enum · required
Enum values:
CacheStrategy
Contract
CustomTheming
ExtraCache
Hipaa
PdfExports
UiLocalization
Tier

expirystring · date
valuestring

AppliedMemoryItem

strategystring · enum · required
How the item was selected: ALWAYS is injected unconditionally, AUTO by relevance.
Enum values:
ALWAYS
AUTO
titlestring · required
Title of the injected memory item.

score
Relevance score the retrieval ranked this item by. Null for ALWAYS items, which are not ranked.

ApplyMemoryDetail

categorystring · const
Category this body belongs to.
Const value: applyMemory
Default: applyMemory
itemsobject[]
Memory items injected into this turn's prompt.

ArithmeticMeasure

leftobject · required
First metric.
operatorstring · enum · required
Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.
Enum values:
DIFFERENCE
CHANGE
rightobject · required
Second metric.

ArithmeticMeasureDefinition

arithmeticMeasureobject · required

ArithmeticOperator

string · enum

Enum values:

DIFFERENCE

CHANGE

Arithmetic operator between two metrics of a relative condition.

AssigneeIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of the assignee.
typestring · enum · required
Enum values:
user
userGroup

AssigneeRule

typestring · enum · required
Enum values:
allWorkspaceUsers

AttributeElements

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: uris
	type = object · requires: values

Properties for Variant 1:

uris(string | null)[] · required
List of attribute elements by reference

AttributeElementsByRef

uris(string | null)[] · required
List of attribute elements by reference

AttributeElementsByValue

values(string | null)[] · required
List of attribute elements by value

AttributeExecutionResultHeader

attributeHeaderobject · required
Header containing the information related to attributes.

AttributeFilter

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: negativeAttributeFilter
	type = object · requires: positiveAttributeFilter
	type = object · requires: matchAttributeFilter

Properties for NegativeAttributeFilter:

Filter able to limit element values by label and related selected negated elements.

negativeAttributeFilterobject · required

AttributeFilterByDate

filterLocalIdentifierstring · required
isCommonDateboolean · required

AttributeFilterElements

values(string | null)[] · unique · required
Set of label values.
Example: ["value1","value2"]

AttributeFilterParent

filterLocalIdentifierstring · required
overobject · required

AttributeFilterState

excludestring[]
includestring[]

AttributeFormat

localestring · required
Format locale code like 'en-US', 'cs-CZ', etc.
patternstring · required
ICU formatting pattern like 'y', 'dd.MM.y', etc.

timezonestring
Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.

AttributeHeader

attributeHeaderobject · required

AttributeItem

labelobject · required
localIdentifierstring · pattern: ^[.a-zA-Z0-9_-]+$ · required
Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
Example: attribute_1

showAllValuesboolean
Indicates whether to show all values of given attribute even if the data bound to those values is not available.
Default: false

AttributeNegativeFilter

excludestring[] · required
usingstring · required

AttributePositiveFilter

includestring[] · required
usingstring · required

AttributeResultHeader

labelValuestring · required
A value of the current attribute label.
Example: East Coast
primaryLabelValuestring · required
A value of the primary attribute label.
Example: 1225

AttributeSortItem

bystring · required
directionstring · enum · required
Enum values:
ASC
DESC
typestring · const · required
Const value: attribute_sort

aggregationstring · const
Const value: SUM

AuthUser

displayNamestring · required
User description, which will be visible in application.
Example: jeremy
emailstring · email · required
Email - used as lookup (must be unique). For PUT method, it must be same as in URL
Example: zeus@example.com

authenticationIdstring
Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).
passwordstring
User password. It is not returned by GET method.

AutomationAlert

conditionobject · required
Alert trigger condition.
executionobject · required

intervalstring · enum
Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
Enum values:
DAY
WEEK
MONTH
QUARTER
YEAR
triggerstring · enum
Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.
Enum values:
ALWAYS
ONCE
ONCE_PER_INTERVAL
Default: ALWAYS

AutomationDashboardTabularExport

requestPayloadobject · required
Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).

AutomationExternalRecipient

emailstring · email · required
E-mail address to send notifications from.

AutomationImageExport

requestPayloadobject · required
Export request object describing the export properties and metadata for image exports.

AutomationMetadata

AutomationNotification

typestring · enum · required
Enum values:
AUTOMATION
contentobject · required

AutomationRawExport

requestPayloadobject · required
Export request object describing the export properties and overrides for raw exports.

AutomationSchedule

cronstring · maxLength: 255 · required
Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
Example: 0 */30 9-17 ? * MON-FRI
timezonestring · maxLength: 255 · required
Timezone in which the schedule is defined.
Example: Europe/Prague

cronDescriptionstring · readOnly
Human-readable description of the cron expression.
firstRunstring · date-time
Timestamp of the first scheduled action. If not provided default to the next scheduled time.
Example: 2025-01-01T12:00:00Z

AutomationSlidesExport

requestPayloadobject · required
Export request object describing the export properties and metadata for slides exports.

AutomationTabularExport

requestPayloadobject · required
Export request object describing the export properties and overrides for tabular exports.

AutomationVisualExport

requestPayloadobject · required
Export request object describing the export properties and metadata for dashboard PDF exports.

AvailableAssignees

userGroupsobject[] · required
List of user groups
usersobject[] · required
List of users

AwsBedrockAccessKeyAuth

typestring · enum · required
Authentication type.
Enum values:
ACCESS_KEY

accessKeyIdstring | null · maxLength: 255 · writeOnly
AWS Access Key ID.
secretAccessKeystring | null · maxLength: 10000 · writeOnly
AWS Secret Access Key.
sessionTokenstring | null · maxLength: 10000 · writeOnly
AWS Session Token (for temporary credentials).

AwsBedrockProviderConfig

authobject · required
Authentication configuration.
regionstring · maxLength: 255 · required
AWS region for Bedrock.
Example: us-east-1
typestring · enum · required
Provider type.
Enum values:
AWS_BEDROCK

AzureFoundryApiKeyAuth

typestring · enum · required
Authentication type.
Enum values:
API_KEY

apiKeystring | null · maxLength: 255 · writeOnly
Azure API key.

AzureFoundryProviderAuth

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: type

Properties for Variant 1:

typestring · enum · required
Authentication type.
Enum values:
API_KEY

apiKeystring | null · maxLength: 255 · writeOnly
Azure API key.

AzureFoundryProviderConfig

authobject · required
Authentication configuration.
endpointstring · maxLength: 255 · required
Azure OpenAI endpoint URL.
Example: https://my-resource.openai.azure.com
typestring · enum · required
Provider type.
Enum values:
AZURE_FOUNDRY

BedrockProviderAuth

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: type

Properties for Variant 1:

typestring · enum · required
Authentication type.
Enum values:
ACCESS_KEY

accessKeyIdstring | null · maxLength: 255 · writeOnly
AWS Access Key ID.
secretAccessKeystring | null · maxLength: 10000 · writeOnly
AWS Secret Access Key.
sessionTokenstring | null · maxLength: 10000 · writeOnly
AWS Session Token (for temporary credentials).

Body_createDocument

filestring · required

scopes
title

Body_createOrgDocument

filestring · required

scopes
title

Body_upsertDocument

filestring · required

scopes
title

Body_upsertOrgDocument

filestring · required

scopes
title

BoundedFilter

granularitystring · enum · required
Date granularity specifying particular date attribute in given dimension.
Enum values:
SECOND
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR
HOUR_OF_DAY
Example: DAY

frominteger | null · int32
Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.
Example: -6
tointeger | null · int32
End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.
Example: 0

BoundedFilter-Input

granularitystring · enum · required
Enum values:
MINUTE
HOUR
DAY
WEEK
MONTH
QUARTER
YEAR
MINUTE_OF_HOUR

from
to

BoundedFilter-Output

granularitystring · enum · required
Enum values:
MINUTE
HOUR
DAY
WEEK
MONTH
QUARTER
YEAR
MINUTE_OF_HOUR

from
to

BucketRefObject

fieldstring · required

CacheRemovalInterval

fromstring · date-time · required
Start timestamp of the removal interval.
removedinteger · int64 · required
Bytes removed during this interval.
tostring · date-time · required
End timestamp of the removal interval.

CacheRetention

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: type
	type = object · requires: type, validityPeriod
	type = object · requires: schedule, type

Properties for Variant 1:

The cache never expires on its own; it is kept per `cacheStrategy` and invalidated only explicitly. Equivalent to setting no policy at all.

typestring · enum · required
The cache retention type.
Enum values:
INDEFINITE

CacheRetentionSchedule

cronstring · required
Cron expression determining when the cached results expire.
Example: 0 0 5 * * *

timezonestring | null
Timezone the cron expression is evaluated in. Defaults to UTC when not set.
Example: Europe/Prague

CacheUsageData

organizationCacheUsageobject · required
Data about the whole organization's cache usage.
workspaceCacheUsagesobject · required
Map of data about the cache usage of the individual workspaces.

CalendarDefinition

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · type="custom" · requires: dataSourceTables
	type = object · type="fiscalYear" · requires: monthOffset

Properties for Variant 1:

Calendar backed by custom fiscal calendar tables defined per data source.

dataSourceTablesobject · required
Custom fiscal calendar table per data source ID.
Example: {"my-postgres":{"path":["schema1","table1"],"version":"v1"}}
typestring · enum · required
Enum values:
custom

CalendarGranularity

granularitystring · enum · required
Fiscal granularity available in the calendar. Corresponds to the calcique granularity name.
Enum values:
SECOND
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR
HOUR_OF_DAY
Example: FISCAL_MONTH
prefixstring · maxLength: 255 · required
Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism.
Example: FP

CalendarTableReference

pathstring[] · required
Path to the fiscal calendar table.
Example: ["schema1","table1"]
versionstring · maxLength: 255 · required
Version of the fiscal calendar table structure.
Example: v1

CatalogSearchDetail

categorystring · const
Category this body belongs to.
Const value: catalogSearch
Default: catalogSearch
foundobject[]
Titles the search returned, grouped by object type.
querystring[]
Keywords the search looked for. Each runs against every requested type.
requestedTypesstring[]
Catalog types the search asked for.
usedobject[]
Best-matching object per type. Empty for the search modes that do not rank.

CatalogSearchMatch

objectTypestring · required
Catalog type the object is the best match of.
scorenumber · required
Relevance score that ranked it.
titlestring · required
Title of the highest-ranked object.

CertificationInfo

statusstring · required
Certification status, e.g. CERTIFIED.

certificationMessagestring
Optional message describing the certification.

ChangeAnalysisParams

analyzedPeriodstring · required
The analyzed time period
attributesobject[] · required
Attributes to analyze for significant changes
dateAttributeobject · required
filtersobject[] · required
Optional filters to apply
measureobject · required
Metric is a quantity that is calculated from the data.
measureTitlestring · required
The title of the measure being analyzed
referencePeriodstring · required
The reference time period
useSmartAttributeSelectionboolean · required
Whether to use smart attribute selection

ChangeAnalysisRequest

analyzedPeriodstring · required
The analyzed time period (e.g., '2025-02')
dateAttributeobject · required
measureobject · required
Metric is a quantity that is calculated from the data.
referencePeriodstring · required
The reference time period (e.g., '2025-01')

attributesobject[]
Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.
auxMeasuresobject[]
Auxiliary measures
excludeTagsstring[]
Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.
filtersobject[]
Optional filters to apply.
includeTagsstring[]
Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.
useSmartAttributeSelectionboolean
Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.
Default: false

ChangeAnalysisResponse

linksobject · required
Links to the execution result.

ChangeAnalysisResult

dataobject[] · required
The change analysis result data containing significant changes.

ChatHistoryInteraction

chatHistoryInteractionIdstring · required
Chat History interaction ID. Unique ID for each interaction.
interactionFinishedboolean · required
Has the interaction already finished? Can be used for polling when interaction is in progress.
questionstring · maxLength: 2000 · required
User question
routingobject · required
Question -> Use Case routing. May contain final answer is a special use case is not required.

changeAnalysisParamsobject
Change analysis specification.
createdVisualizationsobject
Visualization definitions created by AI.
errorResponsestring
Error response in anything fails.
foundObjectsobject
List of objects found by similarity search and post-processed by LLM.
reasoningobject
Reasoning wrapper containing steps taken during request handling.
semanticSearchobject
textResponsestring
Text response for general questions.
threadIdSuffixstring
Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
userFeedbackstring · enum
User feedback.
Enum values:
POSITIVE
NEGATIVE
NONE

ChatHistoryRequest

chatHistoryInteractionIdstring
Return chat history records only after this interaction ID. If empty, complete chat history is returned.
resetboolean
User feedback.
responseStatestring · enum
Response state indicating the outcome of the AI interaction.
Enum values:
SUCCESSFUL
UNEXPECTED_ERROR
NOT_FOUND_ATTRIBUTES
TOO_MANY_DATA_POINTS
NO_DATA
NO_RESULTS
OUT_OF_TOPIC
savedVisualizationobject
Created and saved visualization IDs.
threadIdSuffixstring
Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
userFeedbackstring · enum
User feedback.
Enum values:
POSITIVE
NEGATIVE
NONE
userTextFeedbackstring
User text feedback for the interaction.

ChatHistoryResult

interactionsobject[] · required
List of chat history interactions.
threadIdstring · required
The conversation thread ID.

ChatRequest

questionstring · maxLength: 2000 · required
User question

allowedRelationshipTypesobject[]
Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).
includeHiddenboolean
If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.
Default: false
limitCreateinteger · int32
Maximum number of created results.
Default: 3
limitCreateContextinteger · int32
Maximum number of relevant objects included into context for LLM (for each object type).
Default: 10
limitSearchinteger · int32
Maximum number of search results.
Default: 5
objectTypesstring[]
List of object types to filter the search and visualization building. If empty or null, all object types are considered.
Enum values:
attribute
metric
fact
label
date
dataset
visualization
dashboard
relevantScoreThresholdnumber · double
Score, above which we return found objects. Below this score objects are not relevant.
Default: 0.45
searchScoreThresholdnumber · double
Score, above which we return found object(s) and don't call LLM to create new objects.
Default: 0.9
threadIdSuffixstring
Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
titleToDescriptorRationumber · double
Temporary for experiments. Ratio of title score to descriptor score.
Default: 0.7
userContextobject
User context with ambient UI state (view) and explicitly referenced objects.

ChatResult

changeAnalysisParamsobject
Change analysis specification.
chatHistoryInteractionIdstring
Chat History interaction ID. Unique ID for each interaction.
createdVisualizationsobject
Visualization definitions created by AI.
errorResponsestring
Error response in anything fails.
foundObjectsobject
List of objects found by similarity search and post-processed by LLM.
reasoningobject
Reasoning wrapper containing steps taken during request handling.
routingobject
Question -> Use Case routing. May contain final answer is a special use case is not required.
semanticSearchobject
textResponsestring
Text response for general questions.
threadIdSuffixstring
Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
usageobject[]
AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).

ChatUsageResponse

interactionCountinteger · int32 · required
Number of interactions in the time window
interactionLimitinteger · int32 · required
Maximum number of interactions in the time window any user can do in the workspace
timeWindowHoursinteger · int32 · required
Time window in hours

ClusteringConfig

numberOfClustersinteger · int32 · required
Number of clusters to create
thresholdnumber · float · required
Clustering algorithm threshold

ClusteringRequest

numberOfClustersinteger · int32 · min: 1 · required
Number of clusters to create

thresholdnumber · double
Threshold used for algorithm
Default: 0.03

ClusteringResult

attributeobject[] · required
clusters(integer | null)[] · required
xcoordnumber[] · required
ycoordnumber[] · required

xCoord(number | null)[] · writeOnly
yCoord(number | null)[] · writeOnly

ColumnExpression

columnstring · required
Source column produced by parquet schema inference (after columnOverrides).
functionstring · enum · required
StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement.
Enum values:
HLL_HASH
BITMAP_HASH
BITMAP_HASH64
TO_BITMAP

ColumnInfo

namestring · required
Column name
typestring · required
SQL column type (e.g. VARCHAR(200), BIGINT, DOUBLE)

ColumnLocation

ColumnOverride

namestring · required
Column name.
Example: column_name

labelTargetColumnstring
Specifies the attribute's column to which this label is associated.
Example: users
labelTypestring · enum
Label type for the target attribute.
Enum values:
TEXT
HYPERLINK
GEO
GEO_LONGITUDE
GEO_LATITUDE
GEO_AREA
GEO_ICON
IMAGE
Example: HYPERLINK
ldmTypeOverridestring · enum
Logical Data Model type for the column.
Enum values:
FACT
LABEL
Example: FACT

ColumnPartitionConfig

columnsstring[] · required
Columns to partition by.
typestring · enum · required
Enum values:
column

ColumnStatistic

typestring · enum · required
Enum values:
COUNT
COUNT_NULL
COUNT_UNIQUE
AVG
STDDEV
MIN
MAX
PERCENTILE_25

valuestring

ColumnStatisticWarning

actionstring · required
messagestring · required

ColumnStatisticsEntry

columnNamestring · required

dataSizeinteger · int64
Total data size of the column in bytes.
maxstring
Maximum value in the column (string-encoded).
minstring
Minimum value in the column (string-encoded).
ndvinteger · int64
NDV (Number of Distinct Values) — approximate cardinality of the column.
nullCountinteger · int64
Number of NULL values in the column.

ColumnStatisticsRequest

columnNamestring · required
fromrequired

frequencyobject
histogramobject
statisticsstring[] · unique
Enum values:
COUNT
COUNT_NULL
COUNT_UNIQUE
AVG
STDDEV
MIN
MAX
PERCENTILE_25

ColumnStatisticsResponse

frequencyobject
histogramobject
statisticsobject[]
warningsobject[]

ColumnWarning

messagestring · required
Warning message related to the column.
namestring · required
Column name.

Comparison

leftobject · required
Metric being compared.
operatorstring · enum · required
Comparison operator.
Enum values:
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
EQUAL_TO
NOT_EQUAL_TO
rightobject · required
Value or metric the left side is compared to.

ComparisonCondition

comparisonobject · required
Scalar comparison condition.

ComparisonConditionOperator

string · enum

Enum values:

GREATER_THAN

GREATER_THAN_OR_EQUAL_TO

LESS_THAN

LESS_THAN_OR_EQUAL_TO

EQUAL_TO

NOT_EQUAL_TO

Operator of a scalar comparison condition.

ComparisonMeasureValueFilter

comparisonMeasureValueFilterobject · required

ComparisonMeasureValueFilterBody

measurerequired
operatorstring · enum · required
Enum values:
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
EQUAL_TO
NOT_EQUAL_TO
valuenumber · required

applyOnResult
dimensionality
localIdentifier
treatNullValuesAs

ComparisonMeasureValueOperator

string · enum

Enum values:

GREATER_THAN

GREATER_THAN_OR_EQUAL_TO

LESS_THAN

LESS_THAN_OR_EQUAL_TO

EQUAL_TO

NOT_EQUAL_TO

ComparisonWrapper

comparisonobject · required

ComposeAnswerDetail

categorystring · const
Category this body belongs to.
Const value: composeAnswer
Default: composeAnswer
modelId
Model that generated the answer.
output
What the turn produced, named by the richest part of its answer.
suggestedActions
Follow-up actions the answer offered, null when it carried no suggestions.

CompoundMeasureValueFilter

compoundMeasureValueFilterobject · required

CompoundMeasureValueFilterBody

conditionsarray · required
measurerequired

applyOnResult
dimensionality
localIdentifier
treatNullValuesAs

ConditionalFormattingAbsoluteDateValue

fromstring · required
YYYY-MM-DD, or YYYY-MM-DD HH:mm at hour or minute granularity.
kindstring · enum · required
The value kind.
Enum values:
absoluteDate
tostring · required
YYYY-MM-DD, or YYYY-MM-DD HH:mm at hour or minute granularity. Inclusive.

ConditionalFormattingCondition

formatobject · required
Visual formatting applied to a matching cell.
operatorstring · enum · required
How a condition compares the cell value against its value.
Enum values:
ALL
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
EQUAL_TO
NOT_EQUAL_TO
BETWEEN
valueobject · required
Value a condition compares against. The shape is selected by the kind property.

idstring
Client-assigned identifier, stable across edits.
Example: d0538854-aac3-4fc6-9603-61f49bab6aa3

ConditionalFormattingFormat

scopestring · enum · required
Whether the formatting applies to the matching cell only, or to its whole row.
Enum values:
cell
row

backgroundColorstring
Background color as a hex triplet.
Example: #3DB36B
colorstring
Text color as a hex triplet.
Example: #E54D40

ConditionalFormattingLiteral

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = number

Properties for Variant 1:

string

ConditionalFormattingLiteralRangeValue

fromnumber · double · required
kindstring · enum · required
The value kind.
Enum values:
literalRange
tonumber · double · required

ConditionalFormattingLiteralValue

kindstring · enum · required
The value kind.
Enum values:
literal
valuerequired
A string or a number, serialized in whichever form it was authored.

ConditionalFormattingNoneValue

kindstring · enum · required
The value kind.
Enum values:
none

ConditionalFormattingRelativeDateValue

frominteger · int32 · required
Offset in periods; 0 is the current period, negative is the past.
Example: -29
granularitystring · enum · required
Granularity the offsets are counted in.
Enum values:
ALL_TIME_GRANULARITY
GDC.time.year
GDC.time.week_us
GDC.time.week_in_year
GDC.time.week_in_quarter
GDC.time.week
GDC.time.euweek_in_year
GDC.time.euweek_in_quarter
Example: GDC.time.month
kindstring · enum · required
The value kind.
Enum values:
relativeDate
tointeger · int32 · required
Offset in periods, not lower than from.
Example: 0

ConditionalFormattingValue

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: kind
	type = object · requires: kind, value
	type = object · requires: from, kind, to
	type = object · requires: from, kind, to
	type = object · requires: from, granularity, kind +1 more

Properties for Variant 1:

No value; used by operators that take none.

kindstring · enum · required
The value kind.
Enum values:
none

ContentSlideTemplate

ConversationFeedbackRequest

feedbackrequired
responseIdstring · minLength: 1 · required

ConversationItemListResponse

itemsobject[] · required
Ordered list of conversation items.

ConversationItemResponse

contentrequired
Conversation item content payload.
conversationIdstring · required
Parent conversation identifier.
createdAtstring · required
Item creation timestamp (ISO-8601 UTC).
itemIdstring · required
Conversation item identifier.
itemIndexinteger · required
Zero-based item order within the response turn.
rolestring · enum · required
Author role of the item.
Enum values:
user
assistant
tool
system

actorUserId
User who initiated the switch (marker rows only). NULL for drift-driven markers.
agentId
Agent that processed this item. Populated on every persisted item once LX-2483 ships.
detail
What this item's action did, when its category has a card body; null otherwise, and null on the live stream of non-preview conversations — the trace panel is a preview surface. Replayed items keep it.
newAgentId
Agent ID after the switch (marker rows only).
oldAgentId
Agent ID before the switch (marker rows only).
reasoningEffort
Effort this message was sent with. Set only on user items that carried one; null everywhere else, meaning the turn ran at the MEDIUM default.
replyTo
Optional parent item identifier.
responseId
Response/turn identifier grouping related items.
stepId
Interaction step this item belongs to. Null alongside detail on non-preview streams; replayed items keep it.
taskId
Task identifier grouping related work items.
trigger
Why the marker was written (marker rows only).

ConversationListMeta

pageobject · required

ConversationListPageMeta

pageinteger · required
Zero-based page index.
sizeinteger · required
Requested page size.
totalinteger · required
Total count of available conversations.

ConversationListResponse

dataobject[] · required
metaobject · required

ConversationResponse

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

agentId
Identifier of the agent bound to this conversation (if any).
isPreviewboolean
Whether this is a preview conversation.
Default: false
pinnedboolean
Whether this conversation is pinned by the user.
Default: false
title
Conversation title.

ConversationResponseList

responsesobject[] · required
Conversation responses.

ConversationTurnResponse

createdAtstring · required
Response creation timestamp (ISO-8601 UTC).
responseIdstring · required
Response identifier.
updatedAtstring · required
Response update timestamp (ISO-8601 UTC).

feedback
Optional user feedback.

ConversationUpdateRequest

pinned
title

ConvertGeoFileRequest

locationstring · minLength: 1 · required
Location of the file in the staging area to convert.

ConvertGeoFileResponse

locationstring · required
Location of the converted GeoParquet file in the staging area.

CoverSlideTemplate

CreateConversationRequest

agentId

CreatePipeTableRequest

pathPrefixstring · required
Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.
sourceStorageNamestring · required
Name of the pre-configured S3/MinIO ObjectStorage source
tableNamestring · required
Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$

aggregationOverridesobject
Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.
columnExpressionsobject
Per-target-column projection overrides. Each entry emits <function>(<column>) AS <key> in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).
columnOverridesobject
Override inferred column types. Maps column names to SQL type strings (e.g. {"year": "INT", "event_date": "DATE"}). Applied after parquet schema inference.
distributionConfig
keyConfig
maxVarcharLengthinteger · int32
Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.
partitionConfig
pollingIntervalSecondsinteger · int32
How often (in seconds) the pipe polls for new files. 0 or null = use server default.
tablePropertiesobject
CREATE TABLE PROPERTIES key-value pairs. Defaults to {"replication_num": "1"}.

CreatedVisualization

dimensionalityobject[] · required
List of attributes representing the dimensionality of the new visualization
filtersarray · required
List of filters to be applied to the new visualization
idstring · required
Proposed ID of the new visualization
Example: revenue_by_country
metricsobject[] · required
List of metrics to be used in the new visualization
suggestionsobject[] · required
Suggestions for next steps
titlestring · required
Proposed title of the new visualization
Example: Revenue by Country
visualizationTypestring · enum · required
Visualization type requested in question
Enum values:
TABLE
HEADLINE
BAR
LINE
PIE
COLUMN
SCATTER
Example: TABLE

configobject
Visualization config for smart-function rendering.
savedVisualizationIdstring
Saved visualization ID.

CreatedVisualizations

objectsobject[] · required
List of created visualization objects
suggestionsobject[] · required
List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.

reasoningstring · deprecated · required
DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.

CsvConvertOptions

autoDictEncodeboolean
Whether to try to automatically dict-encode string / binary data.
autoDictMaxCardinalityinteger · int32
The maximum dictionary cardinality for autoDictEncode.
checkUtf8boolean
Whether to check UTF8 validity of string columns.
columnTypesobject[]
Information about the column types in the table.
decimalPointstring
The character used as decimal point in floating-point and decimal data.
falseValuesstring[]
Sequence of strings that denote false Booleans in the data.
includeColumnsstring[]
The names of columns to include in the Table. If empty, the Table will include all columns from the CSV file. If not empty, only these columns will be included, in this order.
includeMissingColumnsboolean
If false, columns in includeColumns but not in the CSV file will error out.
nullValuesstring[]
Sequence of strings that denote nulls in the data.
quotedStringsCanBeNullboolean
Whether quoted values can be null.
stringsCanBeNullboolean
Whether string / binary columns can have null values.
timestampParsersstring[]
Sequence of strptime()-compatible format strings, tried in order when attempting to infer or convert timestamp values.
trueValuesstring[]
Sequence of strings that denote true Booleans in the data.

CsvConvertOptionsColumnType

namestring
The column name.
nullableboolean
Whether the data in the given column can be null.
typestring
The column type.

CsvManifestBody

column_date_formatsobject
Map of column names to date formats to use when parsing them as dates.
convertobject
Options for converting CSV files when reading.
parseobject
Options for parsing CSV files.
readobject
Options for reading CSV files.
read_methodstring
Method used to read the CSV file.

CsvParseOptions

delimiterstring
The character delimiting individual cells in the CSV data.
doubleQuoteboolean
Whether two quotes in a quoted CSV value denote a single quote in the data.
escapeCharobject
The character used optionally for escaping special characters or false to disable escaping.
ignoreEmptyLinesboolean
Whether empty lines are ignored in CSV input.
newlinesInValuesboolean
Whether newline characters are allowed in CSV values.
quoteCharobject
The character used optionally for quoting CSV values or false to disable quoting.

CsvReadOptions

autoGenerateColumnNamesboolean
Whether to autogenerate column names if columnNames is empty.
blockSizeinteger · int32
How many bytes to process at a time from the input stream.
columnNamesstring[]
The column names of the target table.
encodingstring
The character encoding of the CSV data.
skipRowsinteger · int32
The number of rows to skip before the column names (if any) and the CSV data.
skipRowsAfterNamesinteger · int32
The number of rows to skip after the column names.
useThreadsboolean
Whether to use multiple threads to accelerate reading.

CustomCalendarDefinition

dataSourceTablesobject · required
Custom fiscal calendar table per data source ID.
Example: {"my-postgres":{"path":["schema1","table1"],"version":"v1"}}
typestring · enum · required
Enum values:
custom

CustomLabel

titlestring · required
Override value.

CustomMetric

formatstring · required
Format override.
titlestring · required
Metric title override.

CustomOverride

labelsobject
Map of CustomLabels with keys used as placeholders in document.
metricsobject
Map of CustomMetrics with keys used as placeholders in document.

Dashboard

idstring · required
titlestring · required
typestring · const · required
Const value: dashboard

descriptionstring
filtersobject
sectionsobject[]
tabsobject[]

DashboardArbitraryAttributeFilter

arbitraryAttributeFilterobject · required

DashboardAttributeFilter

attributeFilterobject · required

DashboardCompoundComparisonCondition

comparisonobject · required

DashboardCompoundConditionItem

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: comparison
	type = object · requires: range

Properties for Variant 1:

comparisonobject · required

DashboardCompoundRangeCondition

rangeobject · required

DashboardContext

idstring · required
Dashboard object ID.
widgetsobject[] · required
Widgets currently visible on the dashboard.

DashboardDateFilter

dateFilterobject · required

frominteger
granularitystring · enum
Date granularity for date filters.
Enum values:
DAY
WEEK_US
MONTH
QUARTER
YEAR
tointeger
typestring · const
Const value: date_filter

DashboardExportSettings

exportInfoboolean
If true, the export will contain the information about the export – exported date, dashboard filters, etc.
Example: true
Default: false
mergeHeadersboolean
Merge equal headers in neighbouring cells. Used for [XLSX] format only.
Example: true
Default: false
pageOrientationstring · enum
Set page orientation. (PDF)
Enum values:
PORTRAIT
LANDSCAPE
Default: PORTRAIT
pageSizestring · enum
Set page size. (PDF)
Enum values:
A3
A4
LETTER
Default: A4

DashboardFilter

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributeFilter
	type = object · requires: dateFilter
	type = object · requires: arbitraryAttributeFilter
	type = object · requires: matchAttributeFilter
	type = object · requires: dashboardMeasureValueFilter

Properties for Variant 1:

attributeFilterobject · required

DashboardIdUpdateRequest

idstring · minLength: 1 · required

DashboardMatchAttributeFilter

matchAttributeFilterobject · required

DashboardMeasureValueFilter

dashboardMeasureValueFilterobject · required

DashboardPart

dashboard
Optional full dashboard draft payload (AAC JSON) when available.
references
AAC bodies of every widget-referenced visualization, when available.
saved_dashboard_id
Id of the persisted analyticalDashboard once the user has saved this draft; null while it is still an unsaved draft. Lets the client distinguish a saved dashboard from a draft (e.g. after reload) and update it in place on further edits.
typestring · const
Type of multipart part.
Const value: dashboard
Default: dashboard

DashboardPermissions

rulesobject[] · required
List of rules
userGroupsobject[] · required
List of user groups
usersobject[] · required
List of users

DashboardPermissionsAssignment

permissionsstring[] · required
Enum values:
EDIT
SHARE
VIEW

DashboardRef

idstring · required
Bound dashboard identifier.

title
Bound dashboard display title.

DashboardReferences

visualizationsobject[] · required
Full AAC body of every widget-referenced visualization that has one available.

DashboardSection

widgetsobject[] · required

descriptionstring
titlestring

DashboardSlidesTemplate

DashboardTab

idstring · required
sectionsobject[] · required
titlestring · required

filtersobject

DashboardTabularExportRequest

fileNamestring · required
Filename of downloaded file without extension.
Example: result
formatstring · enum · required
Requested tabular export type.
Enum values:
XLSX
PDF
Example: XLSX

dashboardFiltersOverrideobject[]
List of filters that will be used instead of the default dashboard filters.
dashboardParametersOverrideobject[]
Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.
dashboardTabsFiltersOverridesobject
Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.
dashboardTabsParametersOverridesobject
Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.
executionSettingsobject
Various settings affecting the process of AFM execution or its result
settingsobject
Additional settings.
widgetIdsstring[] · maxItems: 1 · unique
List of widget identifiers to be exported. Note that only one widget is currently supported.

DashboardTabularExportRequestV2

dashboardIdstring · required
Dashboard identifier
Example: 761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0
fileNamestring · required
Filename of downloaded file without extension.
Example: result
formatstring · enum · required
Requested tabular export type.
Enum values:
XLSX
PDF
Example: XLSX

dashboardFiltersOverrideobject[]
List of filters that will be used instead of the default dashboard filters.
dashboardParametersOverrideobject[]
Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.
dashboardTabsFiltersOverridesobject
Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.
dashboardTabsParametersOverridesobject
Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.
executionSettingsobject
Various settings affecting the process of AFM execution or its result
settingsobject
Additional settings.
widgetIdsstring[] · maxItems: 1 · unique
List of widget identifiers to be exported. Note that only one widget is currently supported.

visualizationstring · required

columnsinteger
rowsnumber
titlestring

DataColumnLocator

propertiesobject · required
Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or "measureGroup") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.
Example: {"measureGroup":"m1","status":"lost"}

DataColumnLocators

propertiesobject
Mapping from dimensions to data column locators.
Example: {"dim2":{"measureGroup":"m1","status":"lost"}}

DataSourceInfo

dataSourceIdstring · required
Identifier of the data source in metadata-api.
dataSourceNamestring · required
Display name of the data source in metadata-api.
idstring · required
Id of the data source association record.

DataSourceParameter

namestring · required
Parameter name.
valuestring · required
Parameter value.

DataSourcePermissionAssignment

assigneeIdentifierobject · required
Identifier of a user or user-group.
permissionsstring[] · required
Enum values:
MANAGE
USE

DataSourceSchemata

schemaNamesstring[] · required

DataSourceStatisticsRequest

tablesobject[] · required

DataSourceStatisticsResponse

tablesobject[] · required

DataSourceTableIdentifier

dataSourceIdstring · maxLength: 255 · required
Data source ID.
Example: my-postgres
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
ID of table.
Example: customers
typestring · enum · required
Data source entity type.
Enum values:
dataSource
Example: dataSource

patharray | null
Path to table.
Example: ["table_schema","table_name"]

DatabaseInstance

dataSourcesobject[] · required
All data source associations for this database instance.
idstring · required
Id of the AI Lake Database instance
namestring · required
Name of the AI Lake Database instance
storageIdsstring[] · unique · required
Set of ids of the storage instances this database instance should access.

DatasetGrain

idstring · required
typestring · enum · required
Enum values:
attribute
date

DatasetReferenceIdentifier

idstring · required
typestring · enum · required
Enum values:
dataset

DatasetWorkspaceDataFilterIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace Data Filters ID.
Example: country_id
typestring · enum · required
Filter type.
Enum values:
workspaceDataFilter
Example: workspaceDataFilter

DateAbsoluteFilter

fromstring · required
tostring · required
usingstring · required

DateFilter

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: absoluteDateFilter
	type = object · requires: absoluteGranularityDateFilter
	type = object · requires: relativeDateFilter
	type = object · requires: allTimeDateFilter

Properties for AbsoluteDateFilter:

A datetime filter specifying exact from and to values.

absoluteDateFilterobject · required

DateFilterAbsolute

fromstring · required
tostring · required
typestring · const · required
Const value: date_filter
usingstring · required

DateFilterGranularity

string · enum

Enum values:

MINUTE

HOUR

DAY

WEEK_US

MONTH

QUARTER

YEAR

MINUTE_OF_HOUR

DateFilterRelative

frominteger · required
granularitystring · enum · required
Date granularity for date filters.
Enum values:
DAY
WEEK_US
MONTH
QUARTER
YEAR
tointeger · required
typestring · const · required
Const value: date_filter
usingstring · required

DateGranularity-Input

string · enum

Enum values:

MINUTE

HOUR

DAY

WEEK

MONTH

QUARTER

YEAR

MINUTE_OF_HOUR

DateRelativeFilter

frominteger · int32 · required
granularitystring · enum · required
Enum values:
SECOND
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR
HOUR_OF_DAY
tointeger · int32 · required
usingstring · required

DateTruncPartitionConfig

columnstring · required
Column to partition on.
typestring · enum · required
Enum values:
dateTrunc
unitstring · enum · required
Date/time unit for partition granularity
Enum values:
year
quarter
month
week
day
hour
minute
second

DateValue

valuestring · required

DeclarativeAgent

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of an agent.
Example: default-ai-assistant

aiKnowledgeboolean
Whether AI knowledge is enabled.
availableToAllboolean
Whether the agent is available to all users.
createdAtstring | null
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
customSkillsstring[]
List of custom skills when skillsMode is CUSTOM.
Enum values:
alert
anomaly_detection
clustering
forecasting
key_driver_analysis
metric
schedule_export
visualization
descriptionstring · maxLength: 10000
Description of the agent.
enabledboolean
Whether the agent is enabled.
Example: true
modifiedAtstring | null
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
namestring · maxLength: 255
Name of the agent.
Example: Default AI Assistant
personalitystring
Personality instructions for the agent.
skillsModestring · enum
Skills mode: ALL or CUSTOM.
Enum values:
all
custom
userGroupsobject[]
User groups this agent is assigned to.

DeclarativeAgents

agentsobject[] · required

DeclarativeAggregatedFact

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Fact ID.
Example: fact.customer_order_count
sourceFactReferenceobject · required
Source object reference (attribute or fact) including aggregation operation.

descriptionstring · maxLength: 10000
Fact description.
Example: A number of orders created by the customer - including all orders, even the non-delivered ones.
isNullableboolean
Flag indicating whether the associated source column allows null values.
Example: false
nullValuestring
Value used in coalesce during joins instead of null.
Example: 0
sourceColumnstring · maxLength: 255
A name of the source column in the table.
Example: customer_order_count
sourceColumnDataTypestring · enum · maxLength: 255
A type of the source column
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: NUMERIC
tagsstring[] · unique
A list of tags.
Example: ["Customers"]

DeclarativeAnalyticalDashboard

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Analytical dashboard ID.
Example: revenues-analysis
titlestring · maxLength: 255 · required
Analytical dashboard title.
Example: Revenues analysis

certificationstring · enum
Certification status of the entity.
Enum values:
CERTIFIED
certificationMessagestring | null
Optional message associated with the certification.
certifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time when the certification was set.
certifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Analytical dashboard description.
Example: Period to period comparison of revenues in main sectors.
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
permissionsarray
A list of permissions.
summarystring · maxLength: 10000
AI-generated summary of the dashboard content
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]

DeclarativeAnalyticalDashboardExtension

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Analytical dashboard ID.
Example: revenues-analysis
permissionsarray · required
A list of permissions.

DeclarativeAnalyticalDashboardIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of the analytical dashboard.
Example: dashboard123
typestring · enum · required
A type.
Enum values:
analyticalDashboard
Example: analyticalDashboard

DeclarativeAnalyticalDashboardPermissionAssignment

namestring · enum · required
Permission name.
Enum values:
EDIT
SHARE
VIEW

DeclarativeAnalyticalDashboardPermissionForAssignee

namestring · enum · required
Permission name.
Enum values:
EDIT
SHARE
VIEW
assigneeobject · required
Identifier of a user or user-group.

DeclarativeAnalyticalDashboardPermissionForAssigneeRule

namestring · enum · required
Permission name.
Enum values:
EDIT
SHARE
VIEW
assigneeRuleobject · required
Identifier of an assignee rule.

DeclarativeAnalytics

analyticsobject

DeclarativeAnalyticsLayer

analyticalDashboardExtensionsobject[]
A list of dashboard permissions assigned to a related dashboard.
analyticalDashboardsobject[]
A list of analytical dashboards available in the model.
attributeHierarchiesobject[]
A list of attribute hierarchies.
dashboardPluginsobject[]
A list of dashboard plugins available in the model.
exportDefinitionsobject[]
A list of export definitions.
filterContextsobject[]
A list of filter contexts available in the model.
memoryItemsobject[]
A list of AI memory items available in the workspace.
metricsobject[]
A list of metrics available in the model.
parametersobject[]
A list of parameters available in the model.
visualizationObjectsobject[]
A list of visualization objects available in the model.

DeclarativeAttribute

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Attribute ID.
Example: attr.customers.customer_name
labelsobject[] · required
An array of attribute labels.
titlestring · maxLength: 255 · required
Attribute title.
Example: Customer Name

conditionalFormattingobject | null
Conditional formatting inherited by every table column that renders this object.
defaultViewobject
A label identifier.
descriptionstring · maxLength: 10000
Attribute description.
Example: Customer name including first and last name.
isHiddenboolean
If true, this attribute is hidden from AI search results.
Example: false
isNullableboolean
Flag indicating whether the associated source column allows null values.
Example: false
localestring
Default locale for primary label.
Example: en-US
nullValuestring
Value used in coalesce during joins instead of null.
Example: empty_value
sortColumnstring · maxLength: 255
Attribute sort column.
Example: customer_name
sortDirectionstring · enum
Attribute sort direction.
Enum values:
ASC
DESC
Example: "ASC" | "DESC"
sourceColumnstring · maxLength: 255
A name of the source column that is the primary label
Example: customer_name
sourceColumnDataTypestring · enum · maxLength: 255
A type of the source column
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: STRING
tagsstring[] · unique
A list of tags.
Example: ["Customers"]

DeclarativeAttributeHierarchy

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Attribute hierarchy object ID.
Example: hierarchy-1
titlestring · maxLength: 255 · required
Attribute hierarchy object title.
Example: Count of goods

createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Attribute hierarchy object description.
Example: Simple number for total goods in current production.
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]

DeclarativeAutomation

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

alertobject
analyticalDashboardobject
An analytical dashboard identifier.
createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
dashboardTabularExportsobject[] · unique
descriptionstring · maxLength: 255
detailsobject · maxLength: 10000
TODO
evaluationModestring · enum
Specify automation evaluation mode.
Enum values:
SHARED
PER_RECIPIENT
Default: PER_RECIPIENT
exportDefinitionsobject[] · unique
externalRecipientsobject[] · unique
External recipients of the automation action results.
imageExportsobject[] · unique
metadataobject | null · maxLength: 250000
Additional information for the automation.
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
notificationChannelobject
A notification channel identifier.
rawExportsobject[] · unique
recipientsobject[] · unique
scheduleobject
slidesExportsobject[] · unique
statestring · enum
Current state of the automation.
Enum values:
ACTIVE
PAUSED
Default: ACTIVE
tabularExportsobject[] · unique
tagsstring[] · unique
titlestring · maxLength: 255
visualExportsobject[] · unique

DeclarativeCalendar

definitionobject · required
Fiscal calendar definition. The concrete shape is selected by the type discriminator.
enabledGranularitiesobject[] · required
Granularities available in the calendar. Order defines the default drill-down order and mimics the granularity dependency hierarchy.
namestring · maxLength: 255 · required
Calendar title.
Example: Fiscal calendar

descriptionstring · maxLength: 10000
Calendar description.
Example: Custom fiscal calendar starting in April.

DeclarativeColorPalette

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · required
namestring · maxLength: 255 · required

DeclarativeColumn

dataTypestring · enum · required
Column type
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: INT
namestring · maxLength: 255 · required
Column name. Must not contain NUL (0x00) characters.
Example: customer_id

descriptionstring · maxLength: 10000
Column description/comment from database
Example: Customer unique identifier
isNullableboolean
Column is nullable
isPrimaryKeyboolean
Is column part of primary key?
nullValuestring
Value used as sentinel for nullable columns
referencedTableColumnstring · maxLength: 255
Referenced table (Foreign key)
Example: customer_id
referencedTableIdstring · maxLength: 255
Referenced table (Foreign key)
Example: customers

DeclarativeCspDirective

directivestring · maxLength: 255 · required
sourcesstring[] · required

DeclarativeCustomApplicationSetting

applicationNamestring · maxLength: 255 · required
The application id
Example: Modeler
contentobject | null · maxLength: 250000 · required
Free-form JSON content. Maximum supported length is 250000 characters.
Example: {}
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Custom Application Setting ID.
Example: modeler.demo

DeclarativeCustomGeoCollection

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Custom geo collection ID.
Example: my-geo-collection

descriptionstring · maxLength: 10000
Description of the custom geo collection.
namestring · maxLength: 255
Name of the custom geo collection.
Example: My Geo Collection

DeclarativeCustomGeoCollections

customGeoCollectionsobject[] · required

DeclarativeDashboardPlugin

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Dashboard plugin object ID.
Example: dashboard-plugin-1
titlestring · maxLength: 255 · required
Dashboard plugin object title.
Example: 3D map renderer

createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Dashboard plugin description.
Example: Three dimensional view of data.
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]

DeclarativeDataSource

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Data source ID.
Example: pg_local_docker-demo
namestring · maxLength: 255 · required
Name of the data source.
Example: postgres demo
schemastring · maxLength: 255 · required
A scheme/database with the data.
Example: demo
typestring · enum · required
Type of database.
Enum values:
POSTGRESQL
REDSHIFT
VERTICA
SNOWFLAKE
ADS
BIGQUERY
MSSQL
PRESTO
Example: POSTGRESQL

alternativeDataSourceIdstring | null · pattern: ^(?!\.)[.A-Za-z0-9_-…
Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.
Example: pg_local_docker-demo2
authenticationTypestring | null · enum
Type of authentication used to connect to the database.
Enum values:
USERNAME_PASSWORD
TOKEN
KEY_PAIR
CLIENT_SECRET
OIDC_PASSTHROUGH
cacheRetentionobject | null
Determines when the cached results coming from a particular data source expire. The shape is selected by the type property.
cacheStrategystring · enum
Determines how the results coming from a particular datasource should be cached.
- ALWAYS: The results from the datasource should be cached normally (the default).
- NEVER: The results from the datasource should never be cached.
Enum values:
ALWAYS
NEVER
clientIdstring · maxLength: 255
Id of client with permission to connect to the data source.
Example: client1234
clientSecretstring · maxLength: 255
The client secret to use to connect to the database providing the data for the data source.
dateTimeSemanticsstring | null · enum
Determines how datetime values are interpreted in data sources without native support for specifying this.
- LOCAL: The values are assumed to be in local timezone and they are not converted to the user's timezone.
- UTC: The values are assumed to be in UTC and they are converted to the user's timezone.
Enum values:
LOCAL
UTC
decodedParametersobject[]
parametersobject[]
passwordstring · maxLength: 255
Password for the data-source user, property is never returned back.
Example: *****
permissionsobject[]
privateKeystring | null · maxLength: 15000
The private key to use to connect to the database providing the data for the data source.
privateKeyPassphrasestring | null · maxLength: 255
The passphrase used to encrypt the private key.
tokenstring · maxLength: 10000
Token as an alternative to username and password.
Example: Bigquery service account JSON. Encode it using base64!
urlstring · maxLength: 255
An connection string relevant to type of database.
Example: jdbc:postgresql://postgres:5432/gooddata
usernamestring · maxLength: 255
User with permission connect the data source/database.
Example: demo

DeclarativeDataSourcePermission

assigneeobject · required
Identifier of a user or user-group.
namestring · enum · required
Permission name.
Enum values:
MANAGE
USE

DeclarativeDataSourcePermissions

permissionsobject[]

DeclarativeDataSources

dataSourcesobject[] · required

DeclarativeDataset

grainobject[] · required
An array of grain identifiers.
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
The Dataset ID. This ID is further used to refer to this instance of dataset.
Example: customers
referencesobject[] · required
An array of references. The semantics of sources depends on the dataset shape: for NORMAL→NORMAL references, sources is a compound foreign key to the target dataset's grain (one source per grain component, dataType-matched). For pre-aggregation datasets (NORMAL with aggregatedFacts), sources is reinterpreted as independent column→attribute mappings — one entry per source — and targets are NOT required to be grain components.
titlestring · maxLength: 255 · required
A dataset title.
Example: Customers

aggregatedFactsobject[]
An array of aggregated facts. Presence makes the dataset a pre-aggregation dataset, which requires precedence > 0 and must NOT be set on AUXILIARY datasets.
attributesobject[]
An array of attributes.
dataSourceTableIdobject
An id of the table. Including ID of data source. Must NOT be set on AUXILIARY datasets.
Example: {"dataSourceId":"my-postgres","id":"customers","type":"DATA_SOURCE"}
descriptionstring · maxLength: 10000
A dataset description.
Example: The customers of ours.
factsobject[]
An array of facts.
precedenceinteger · int32 · min: 0
Precedence used in aggregate awareness. Pre-aggregation datasets (NORMAL with aggregatedFacts) MUST set precedence > 0; non-pre-aggregation datasets MUST leave it null. Must NOT be set on AUXILIARY datasets.
Example: 0
sqlobject
SQL defining this dataset. Must NOT be set on AUXILIARY datasets.
Example: {"dataSourceId":"my-postgres","statement":"SELECT * FROM some_table"}
tagsstring[] · unique
A list of tags.
Example: ["Customers"]
typestring · enum
Dataset type. NORMAL is the standard fact/dim dataset. AUXILIARY denotes a synthetic dataset used as a reference target by pre-aggregation datasets (keystone of the aggregate-awareness design); AUX datasets must not carry aggregatedFacts, sql, dataSourceTableId, workspaceDataFilterReferences or precedence. Date datasets use a separate schema and are not represented by this enum.
Enum values:
NORMAL
AUXILIARY
workspaceDataFilterColumnsobject[]
An array of columns which are available for match to implicit workspace data filters.
workspaceDataFilterReferencesobject[]
An array of explicit workspace data filters. Must NOT be set on AUXILIARY datasets.

DeclarativeDatasetExtension

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
The Dataset ID. This ID is further used to refer to this instance of dataset.
Example: customers

workspaceDataFilterReferencesobject[]
An array of explicit workspace data filters.

DeclarativeDatasetSql

dataSourceIdstring · required
Data source ID.
Example: my-postgres
statementstring · required
SQL statement.
Example: SELECT * FROM some_table

DeclarativeDateDataset

granularitiesstring[] · required
An array of date granularities. All listed granularities will be available for date dataset.
Enum values:
SECOND
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR
HOUR_OF_DAY
granularitiesFormattingobject · required
A date dataset granularities title formatting rules.
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Date dataset ID.
Example: date
titlestring · maxLength: 255 · required
Date dataset title.
Example: Date

descriptionstring · maxLength: 10000
Date dataset description.
Example: A customer order date
tagsstring[] · unique
A list of tags.
Example: ["Customer dates"]

DeclarativeExportDefinition

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Export definition id.
Example: export-definition-1
titlestring · maxLength: 255 · required
Export definition object title.
Example: My regular export

createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Export definition object description.
Example: Simple number for total goods in current production.
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
requestPayloadobject
JSON content to be used as export request payload for /export/tabular and /export/visual endpoints.
Example: ["Revenues"]
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]

DeclarativeExportDefinitionIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Export definition identifier.
Example: export123
typestring · enum · required
A type.
Enum values:
exportDefinition
Example: exportDefinition

DeclarativeExportTemplate

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of an export template
Example: default-export-template
namestring · maxLength: 255 · required
Name of an export template.
Example: My default export template

dashboardSlidesTemplateobject | null
Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
widgetSlidesTemplateobject | null
Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}

DeclarativeExportTemplates

exportTemplatesobject[] · required

DeclarativeFact

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Fact ID.
Example: fact.customer_order_count
titlestring · maxLength: 255 · required
Fact title.
Example: Customer order count

descriptionstring · maxLength: 10000
Fact description.
Example: A number of orders created by the customer - including all orders, even the non-delivered ones.
isHiddenboolean
If true, this fact is hidden from AI search results.
Example: false
isNullableboolean
Flag indicating whether the associated source column allows null values.
Example: false
nullValuestring
Value used in coalesce during joins instead of null.
Example: 0
sourceColumnstring · maxLength: 255
A name of the source column in the table.
Example: customer_order_count
sourceColumnDataTypestring · enum · maxLength: 255
A type of the source column
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: NUMERIC
tagsstring[] · unique
A list of tags.
Example: ["Customers"]

DeclarativeFilterContext

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Filter Context ID.
Example: filter-sales
titlestring · maxLength: 255 · required
Filter Context title.
Example: Filter Context for Sales team

descriptionstring · maxLength: 10000
Filter Context description.
Example: Filter Context for Sales team.
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]

DeclarativeFilterView

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
FilterView object ID.
Example: filterView-1
titlestring · maxLength: 255 · required

analyticalDashboardobject
An analytical dashboard identifier.
contentobject | null · maxLength: 15000
Free-form JSON object
Example: {}
descriptionstring · maxLength: 255
isDefaultboolean
Indicator whether the filter view should by applied by default.
tagsstring[] · unique
userobject
A user identifier.
Example: {"id":"example123","type":"user"}

DeclarativeIdentityProvider

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
FilterView object ID.
Example: filterView-1

customClaimMappingobject · maxLength: 10000
Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
identifiersstring[]
List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
Example: ["gooddata.com"]
idpTypestring · enum
Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
Enum values:
MANAGED_IDP
FIM_IDP
DEX_IDP
CUSTOM_IDP
oauthClientIdstring · maxLength: 255
The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
oauthClientSecretstring · maxLength: 255
The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
oauthCustomAuthAttributesobject · maxLength: 10000
Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
oauthCustomScopesarray | null
List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
oauthIssuerIdstring · maxLength: 255
Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
Example: myOidcProvider
oauthIssuerLocationstring · maxLength: 255
The location of your OIDC provider. This field is mandatory for OIDC IdP.
oauthSubjectIdClaimstring · maxLength: 255
Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.
Example: oid
samlMetadatastring · maxLength: 15000
Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.

DeclarativeIdentityProviderIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of the identity provider.
Example: gooddata.com
typestring · enum · required
A type.
Enum values:
identityProvider
Example: identityProvider

DeclarativeIpAllowlistPolicy

allowedSourcesstring[] · required
Allowed source IPv4 addresses or CIDR ranges. Only IPv4 is supported; IPv6 are rejected. The /0 prefix is not allowed.
Example: ["203.0.113.10/32","198.51.100.0/24"]
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of an IP allowlist policy.
Example: admin-vpn-only

userGroupsobject[]
Target user groups this policy applies to.
usersobject[]
Target users this policy applies to.

DeclarativeJwk

contentobject · required
Declarative specification of the cryptographic key.
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
JWK object ID.
Example: jwk-1

DeclarativeJwkSpecification

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: alg, e, kid +3 more

Properties for Variant 1:

Declarative specification of the cryptographic key.

algstring · enum · required
Algorithm intended for use with the key.
Enum values:
RS256
RS384
RS512
Example: RS256
estring · required
parameter contains the exponent value for the RSA public key.
kidstring · maxLength: 255 · pattern: ^[^.] · required
Parameter is used to match a specific key.
Example: key.001
ktystring · enum · required
Key type parameter
Enum values:
RSA
Example: RSA
nstring · required
Parameter contains the modulus value for the RSA public key.
usestring · enum · required
Parameter identifies the intended use of the public key.
Enum values:
sig
Example: sig

x5cstring[]
Parameter contains a chain of one or more PKIX certificates.
x5tstring
Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.

DeclarativeLabel

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Label ID.
Example: label.customer_name
titlestring · maxLength: 255 · required
Label title.
Example: Customer name

descriptionstring · maxLength: 10000
Label description.
Example: Customer name
geoAreaConfigobject
Configuration specific to geo area labels.
isHiddenboolean
Determines if the label is hidden from AI features.
Example: false
isNullableboolean
Flag indicating whether the associated source column allows null values.
Example: false
localestring
Default label locale.
Example: en-US
nullValuestring
Value used in coalesce during joins instead of null.
Example: empty_value
sourceColumnstring · maxLength: 255
A name of the source column in the table.
Example: customer_name
sourceColumnDataTypestring · enum · maxLength: 255
A type of the source column
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: STRING
tagsstring[] · unique
A list of tags.
Example: ["Customers"]
translationsobject[]
Other translations.
valueTypestring · enum
Specific type of label
Enum values:
TEXT
HYPERLINK
GEO
GEO_LONGITUDE
GEO_LATITUDE
GEO_AREA
GEO_ICON
IMAGE

DeclarativeLabelTranslation

localestring · required
Translation locale.
Example: en-US
sourceColumnstring · required
Translation source column.
Example: customer_name_en

DeclarativeLdm

calendarsobject
Custom fiscal calendars keyed by calendar ID. Can be defined only in the root workspace.
datasetExtensionsobject[]
An array containing extensions for datasets defined in parent workspaces.
datasetsobject[]
An array containing datasets.
dateInstancesobject[]
An array containing date-related datasets.

DeclarativeMemoryItem

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Memory item ID.
Example: sales-context
instructionstring · maxLength: 255 · required
The text that will be injected into the system prompt.
Example: When discussing sales, always consider quarterly trends.
strategystring · enum · required
Strategy defining when the memory item should be applied
Enum values:
ALWAYS
AUTO
Example: AUTO
titlestring · maxLength: 255 · required
Memory item title.
Example: Sales Context

createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Memory item description.
Example: Context about sales data for AI assistant.
isDisabledboolean
Whether memory item is disabled.
Example: false
keywordsstring[] · unique
Set of unique strings used for semantic similarity filtering.
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
tagsstring[] · unique
A list of tags.
Example: ["AI","Context"]

DeclarativeMetric

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Metric ID.
Example: total-sales
titlestring · maxLength: 255 · required
Metric title.
Example: Total sales

certificationstring · enum
Certification status of the entity.
Enum values:
CERTIFIED
certificationMessagestring | null
Optional message associated with the certification.
certifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time when the certification was set.
certifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
conditionalFormattingobject | null
Conditional formatting inherited by every table column that renders this object.
createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Metric description.
Example: Sales for all the data available.
isHiddenboolean
If true, this metric is hidden from AI search results.
Example: false
isHiddenFromKdaboolean
If true, this metric is hidden from key drive analysis.
Example: false
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]

DeclarativeModel

ldmobject
A logical data model (LDM) representation.

DeclarativeNotificationChannel

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of a notification channel
Example: notification-channel-1

allowedRecipientsstring · enum
Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
Enum values:
CREATOR
INTERNAL
EXTERNAL
Default: INTERNAL
customDashboardUrlstring · maxLength: 255
Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
dashboardLinkVisibilitystring · enum
Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
Enum values:
HIDDEN
INTERNAL_ONLY
ALL
Default: INTERNAL_ONLY
descriptionstring · maxLength: 10000
Description of a notification channel.
Example: This is a channel
destinationobject
destinationTypestring | null · enum · readOnly
Enum values:
WEBHOOK
SMTP
DEFAULT_SMTP
IN_PLATFORM
inPlatformNotificationstring · enum
In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
Enum values:
DISABLED
ENABLED
Default: DISABLED
namestring · maxLength: 255
Name of a notification channel.
Example: channel
notificationSourcestring · maxLength: 10000
Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}

DeclarativeNotificationChannelIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Notification channel identifier.
Example: webhook123
typestring · enum · required
A type.
Enum values:
notificationChannel
Example: notificationChannel

DeclarativeNotificationChannels

notificationChannelsobject[] · required

DeclarativeOrganization

organizationobject · required
Information available about an organization.

agentsobject[]
customGeoCollectionsobject[]
dataSourcesobject[]
exportTemplatesobject[]
identityProvidersobject[]
ipAllowlistPoliciesobject[]
jwksobject[]
notificationChannelsobject[]
userGroupsobject[]
usersobject[]
workspaceDataFiltersobject[]
workspacesobject[]

DeclarativeOrganizationInfo

hostnamestring · maxLength: 255 · required
Formal hostname used in deployment.
Example: alpha.com
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of the organization.
Example: Alpha corporation
namestring · maxLength: 255 · required
Formal name of the organization.
Example: Alpha corporation
permissionsobject[] · required

allowedOriginsstring[]
colorPalettesobject[]
A list of color palettes.
cspDirectivesobject[]
A list of CSP directives.
earlyAccessValuesstring[] · unique
Early access defined on level Organization
identityProviderobject
An Identity Provider identifier.
settingsobject[]
A list of organization settings.
themesobject[]
A list of themes.

earlyAccessstring · maxLength: 255 · deprecated · required
Early access defined on level Organization

DeclarativeOrganizationPermission

assigneeobject · required
Identifier of a user or user-group.
namestring · enum · required
Permission name.
Enum values:
MANAGE
SELF_CREATE_TOKEN
BASE_UI_ACCESS

DeclarativeParameter

contentobject · required
Parameter content (type-discriminated).
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Parameter ID.
Example: discount-rate
titlestring · maxLength: 255 · required
Parameter title.
Example: Discount Rate

createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Parameter description.
Example: Rate applied to discounted items.
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
tagsstring[] · unique
A list of tags.
Example: ["Finance"]

DeclarativeReference

identifierobject · required
A reference identifier.
multivalueboolean · required
The multi-value flag enables many-to-many cardinality for references.
Example: false

sourcesobject[]
An array of source columns for a given reference.

sourceColumnDataTypesstring[] · deprecated · required
An array of source column data types for a given reference. Deprecated, use 'sources' instead.
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
sourceColumnsstring[] · deprecated · required
An array of source column names for a given reference. Deprecated, use 'sources' instead.
Example: ["customer_id"]

DeclarativeReferenceSource

targetobject · maxLength: 255 · required
A grain identifier.
Example: {"id":"customer_id","type":"attribute"}

columnstring · maxLength: 255
A name of the source column in the table.
Example: customer_id
dataTypestring · enum · maxLength: 255
A type of the source column.
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: STRING
isNullableboolean
Flag indicating whether the associated source column allows null values.
Example: false
nullValuestring
Value used in coalesce during joins instead of null.
Example: empty_value

DeclarativeRsaSpecification

algstring · enum · required
Algorithm intended for use with the key.
Enum values:
RS256
RS384
RS512
Example: RS256
estring · required
parameter contains the exponent value for the RSA public key.
kidstring · maxLength: 255 · pattern: ^[^.] · required
Parameter is used to match a specific key.
Example: key.001
ktystring · enum · required
Key type parameter
Enum values:
RSA
Example: RSA
nstring · required
Parameter contains the modulus value for the RSA public key.
usestring · enum · required
Parameter identifies the intended use of the public key.
Enum values:
sig
Example: sig

x5cstring[]
Parameter contains a chain of one or more PKIX certificates.
x5tstring
Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.

DeclarativeSetting

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Setting ID.

contentobject | null · maxLength: 15000
Free-form JSON object
Example: {}
typestring · enum
Type of the setting.
Enum values:
TIMEZONE
ACTIVE_THEME
ACTIVE_COLOR_PALETTE
ACTIVE_LLM_PROVIDER
ACTIVE_CALENDARS
WHITE_LABELING
LOCALE
METADATA_LOCALE
Example: TIMEZONE

DeclarativeSingleWorkspacePermission

assigneeobject · required
Identifier of a user or user-group.
namestring · enum · required
Permission name.
Enum values:
MANAGE
ANALYZE
EXPORT
EXPORT_TABULAR
EXPORT_PDF
CREATE_AUTOMATION
USE_AI_ASSISTANT
WRITE_KNOWLEDGE_DOCUMENTS

DeclarativeSourceReference

operationstring · enum · required
Aggregation operation.
Enum values:
SUM
MIN
MAX
APPROXIMATE_COUNT
Example: SUM
referenceobject · required
A source reference identifier.

DeclarativeTable

columnsobject[] · required
An array of physical columns
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Table id.
Example: customers
pathstring[] · required
Path to table.
Example: ["table_schema","table_name"]
typestring · required
Table type: TABLE or VIEW.
Example: TABLE

namePrefixstring · maxLength: 255
Table or view name prefix used in scan. Will be stripped when generating LDM.
Example: out_gooddata

DeclarativeTables

tablesobject[] · required
An array of physical database tables.

DeclarativeTheme

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · required
namestring · maxLength: 255 · required

DeclarativeUser

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
User identifier.
Example: employee123

authIdstring · maxLength: 255
User identification in the authentication manager.
emailstring · maxLength: 255
User email address
Example: user@example.com
firstnamestring · maxLength: 255
User first name
Example: John
lastnamestring · maxLength: 255
User last name
Example: Wick
permissionsobject[]
settingsobject[]
A list of user settings.
systemAccountboolean
Is user system account
Example: false
userGroupsobject[]

DeclarativeUserDataFilter

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
User Data Filters ID. This ID is further used to refer to this instance.
Example: country_id_setting
maqlstring · maxLength: 10000 · required
Expression in MAQL specifying the User Data Filter
Example: {label/country} = "USA" AND {label/date.year} = THIS(YEAR)
titlestring · maxLength: 255 · required
User Data Filters setting title.
Example: Country ID setting

descriptionstring · maxLength: 10000
User Data Filters setting description.
Example: ID of country setting
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]
userobject
A user identifier.
Example: {"id":"example123","type":"user"}
userGroupobject
A user group identifier.
Example: {"id":"admins","type":"userGroup"}

DeclarativeUserDataFilters

userDataFiltersobject[] · required

DeclarativeUserGroup

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
UserGroup identifier.
Example: employees.all

namestring · maxLength: 255
Name of UserGroup
Example: admins
parentsobject[]
permissionsobject[]

DeclarativeUserGroupIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of the user group.
Example: group.admins
typestring · enum · required
A type.
Enum values:
userGroup
Example: userGroup

DeclarativeUserGroupPermission

assigneeobject · required
Identifier of a user or user-group.
namestring · enum · required
Permission name.
Enum values:
SEE

DeclarativeUserGroupPermissions

permissionsobject[]

DeclarativeUserGroups

userGroupsobject[] · required

DeclarativeUserIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
User identifier.
Example: employee123
typestring · enum · required
A type.
Enum values:
user
Example: user

DeclarativeUserPermission

assigneeobject · required
Identifier of a user or user-group.
namestring · enum · required
Permission name.
Enum values:
SEE

DeclarativeUserPermissions

permissionsobject[]

DeclarativeUsers

usersobject[] · required

DeclarativeUsersUserGroups

userGroupsobject[] · required
usersobject[] · required

DeclarativeVisualizationObject

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Visualization object ID.
Example: visualization-1
titlestring · maxLength: 255 · required
Visualization object title.
Example: Count of goods

certificationstring · enum
Certification status of the entity.
Enum values:
CERTIFIED
certificationMessagestring | null
Optional message associated with the certification.
certifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time when the certification was set.
certifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the entity creation.
Example: 2023-07-20 12:30
createdByobject
A user identifier.
Example: {"id":"example123","type":"user"}
descriptionstring · maxLength: 10000
Visualization object description.
Example: Simple number for total goods in current production.
isHiddenboolean
If true, this visualization object is hidden from AI search results.
Example: false
modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…
Time of the last entity modification.
Example: 2023-07-20 12:30
modifiedByobject
A user identifier.
Example: {"id":"example123","type":"user"}
tagsstring[] · unique
A list of tags.
Example: ["Revenues"]

DeclarativeWorkspace

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of a workspace
Example: alpha.sales
namestring · maxLength: 255 · required
Name of a workspace to view.
Example: Alpha Sales

automationsobject[]
cacheExtraLimitinteger · int64
Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.
colorPalettesobject[]
A list of workspace color palettes.
customApplicationSettingsobject[]
A list of workspace custom settings.
dataSourceobject
The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
descriptionstring · maxLength: 255
Description of the workspace
earlyAccessValuesstring[] · unique
Early access defined on level Workspace
exportTemplatesobject[]
A list of workspace export templates.
filterViewsobject[]
hierarchyPermissionsobject[]
managedboolean · readOnly
Whether the workspace is platform-managed and read-only. Informational on export; ignored on import (the flag is server-controlled).
modelobject
A declarative form of a model and analytics for a workspace.
parentobject
A workspace identifier.
Example: { id: demo, type: workspace }
permissionsobject[]
prefixstring · maxLength: 255 · pattern: ^(?!\.)[.A-Za-z0-9_-…
Custom prefix of entity identifiers in workspace
settingsobject[]
A list of workspace settings.
themesobject[]
A list of workspace themes.
userDataFiltersobject[]
A list of workspace user data filters.

earlyAccessstring · maxLength: 255 · deprecated · required
Early access defined on level Workspace

DeclarativeWorkspaceColorPalette

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · required
namestring · maxLength: 255 · required

DeclarativeWorkspaceDataFilter

columnNamestring · maxLength: 255 · required
Workspace Data Filters column name. Data are filtered using this physical column.
Example: country_id
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace Data Filters ID. This ID is further used to refer to this instance.
Example: country_id
titlestring · maxLength: 255 · required
Workspace Data Filters title.
Example: Country ID
workspaceobject · required
A workspace identifier.
Example: { id: demo, type: workspace }
workspaceDataFilterSettingsobject[] · required
Filter settings specifying values of filters valid for the workspace.

descriptionstring · maxLength: 10000
Workspace Data Filters description.
Example: ID of country

DeclarativeWorkspaceDataFilterColumn

dataTypestring · enum · required
Data type of the column
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: INT
namestring · required
Name of the column
Example: customer_id

DeclarativeWorkspaceDataFilterReferences

filterColumnstring · required
Filter column name
Example: filter_id
filterColumnDataTypestring · enum · required
Filter column data type
Enum values:
INT
STRING
DATE
NUMERIC
TIMESTAMP
TIMESTAMP_TZ
BOOLEAN
HLL
Example: INT
filterIdobject · required
Identifier of a workspace data filter.

DeclarativeWorkspaceDataFilterSetting

filterValuesstring[] · required
Only those rows are returned, where columnName from filter matches those values.
Example: ["US"]
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace Data Filters ID. This ID is further used to refer to this instance.
Example: country_id_setting
titlestring · maxLength: 255 · required
Workspace Data Filters setting title.
Example: Country ID setting
workspaceobject · required
A workspace identifier.
Example: { id: demo, type: workspace }

descriptionstring · maxLength: 10000
Workspace Data Filters setting description.
Example: ID of country setting

DeclarativeWorkspaceDataFilters

workspaceDataFiltersobject[] · required

DeclarativeWorkspaceExportTemplate

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Identifier of a workspace export template
Example: default-export-template
namestring · maxLength: 255 · required
Name of a workspace export template.
Example: My default export template

dashboardSlidesTemplateobject | null
Template for workspace dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
widgetSlidesTemplateobject | null
Template for workspace widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}

DeclarativeWorkspaceHierarchyPermission

assigneeobject · required
Identifier of a user or user-group.
namestring · enum · required
Permission name.
Enum values:
MANAGE
ANALYZE
EXPORT
EXPORT_TABULAR
EXPORT_PDF
CREATE_AUTOMATION
USE_AI_ASSISTANT
WRITE_KNOWLEDGE_DOCUMENTS

DeclarativeWorkspaceModel

analyticsobject
ldmobject
A logical data model (LDM) representation.

DeclarativeWorkspacePermissions

hierarchyPermissionsobject[]
permissionsobject[]

DeclarativeWorkspaceTheme

contentobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}
idstring · required
namestring · maxLength: 255 · required

DeclarativeWorkspaces

workspaceDataFiltersobject[] · required
workspacesobject[] · required

DefaultSmtp

typestring · enum · required
The destination type.
Enum values:
DEFAULT_SMTP

fromEmailstring · email
E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.
Default: no-reply@gooddata.com
fromEmailNamestring
An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.
Default: GoodData

DeleteDocumentResponse

messagestring · required
successboolean · required

DeleteFilesRequest

fileNamesstring[] · required
Names of the files to delete.

DependentEntitiesGraph

edgesarray[] · unique · required
nodesobject[] · unique · required

DependentEntitiesNode

idstring · required
typestring · enum · required
Object type in the graph.
Enum values:
analyticalDashboard
attribute
attributeHierarchy
dashboardPlugin
dataset
fact
label
metric
Example: metric

titlestring

DependentEntitiesRequest

identifiersobject[] · required

relationstring · enum
Entity relation for graph traversal from the entry points. DEPENDENTS returns entities that depend on the entry points. DEPENDENCIES returns entities that the entry points depend on.
Enum values:
DEPENDENTS
DEPENDENCIES
Default: DEPENDENTS

DependentEntitiesResponse

graphobject · required

DependsOn

labelstring · required
Specifies on which label the filter depends on.
values(string | null)[] · required
Specifies values of the label for element filtering.

complementFilterboolean
Inverse filtering mode.
Default: false

DependsOnDateFilter

dateFilterobject · required
Abstract filter definition type for dates.

DependsOnItem

DependsOnMatchFilter

matchFilterobject · required
Filter via label with given match type and literal value.

DimAttribute

idstring · required
ID of the object
Example: country
titlestring · required
Title of attribute.
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

Dimension

itemIdentifiersstring[] · required
List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute "measureGroup" representing list of metrics.
Example: ["attribute_1","measureGroup"]

localIdentifierstring · pattern: ^[.a-zA-Z0-9_-]+$
Dimension identification within requests. Other entities can reference this dimension by this value.
Example: firstDimension
sortingobject[]
List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).

DimensionHeader

headerGroupsobject[] · required
An array containing header groups.

DistributionConfig

typestring · required

DocumentMetadataResponse

createdAtstring · required
createdBystring · required
filenamestring · required
idstring · required
numChunksinteger · required
scopesstring[] · required
updatedAtstring · required
updatedBystring · required

isDisabled
title
workspaceId

DuplicateKeyConfig

typestring · enum · required
Enum values:
duplicate

columnsstring[]
Key columns. Defaults to first inferred column.

Element

primaryTitlestring · required
Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded
titlestring · required
Title of requested label.

ElementsRequest

labelstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Requested label.
Example: label_id

cacheIdstring
If specified, the element data will be taken from the result with the same cacheId if it is available.
complementFilterboolean
Inverse filters:
- false - return items matching patternFilter and exactFilter
- true - return items not matching patternFilter and exactFilter
Default: false
dependsOnarray
Return only items that are not filtered-out by the parent filters.
exactFilter(string | null)[]
Return only items, whose label title exactly matches one of filter.
excludePrimaryLabelboolean
Excludes items from the result that differ only by primary label
- false - return items with distinct primary label
- true - return items with distinct requested label
Default: false
filterByobject
Specifies what is used for filtering.
patternFilterstring
Return only items, whose label title case insensitively contains filter as substring.
sortOrderstring · enum
Sort order of returned items. Items are sorted by label title. If no sort order is specified then attribute's sortDirection is used, which is ASC by default
Enum values:
ASC
DESC
timezonestring
Time zone (IANA id, e.g. "Europe/Prague") used to resolve relative date filters in dependsOn. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.
Example: Europe/Prague
validateBy(object | null)[]
Return only items that are computable on metric.

dataSamplingPercentagenumber · float · deprecated · required
Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.
Default: 100

ElementsResponse

elementsobject[] · required
List of returned elements.
pagingobject · required
Current page description.
primaryLabelobject · required
Object identifier.

cacheIdstring
The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.
formatobject
Attribute format describes formatting information to effectively format attribute values when needed.
granularitystring · enum
Granularity of requested label in case of date attribute
Enum values:
SECOND
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR
HOUR_OF_DAY

EmptyValueHandling

string · enum

Enum values:

INCLUDE

EXCLUDE

ONLY

EntitlementsRequest

entitlementsNamestring[] · unique · required
Enum values:
CacheStrategy
Contract
CustomTheming
ExtraCache
Hipaa
PdfExports
UiLocalization
Tier

EntityIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Object identifier.
typestring · enum · required
Object type in the graph.
Enum values:
analyticalDashboard
attribute
attributeHierarchy
dashboardPlugin
dataset
fact
label
metric
Example: metric

EntitySearchBody

filterstring | null
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includearray | null
List of related entities to include in the response
metaIncludearray | null · unique
Set of metadata fields to include in the response
pageobject
Pagination information for entity search
sortarray | null
Sorting criteria (can specify multiple sort orders)

EntitySearchPage

indexinteger · int32 · min: 0 · required
Zero-based page index
Default: 0
sizeinteger · int32 · min: 1 · required
Number of items per page
Default: 100

EntitySearchSort

propertystring · required
Property name to sort by

directionstring · enum
Sort direction
Enum values:
ASC
DESC
Default: ASC

ErrorInfo

reasonstring · required
Stable machine-readable error code. Switch on this for localized client messages.
Example: METADATA_SYNC_IN_PROGRESS
statusCodeinteger · int32 · required
HTTP-like semantic status (e.g. 503 when the workspace is still syncing).
Example: 503

ExecutionLinks

executionResultstring · required
Link to the result data.

ExecutionResponse

dimensionsobject[] · required
Dimensions of the result
linksobject · required
Links to the execution result.

ExecutionResult

dataobject[] · required
A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.
Example: [[1,2.5],[-1.3,3.14]]
dimensionHeadersobject[] · required
An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec.
grandTotalsobject[] · required
metadataobject · required
Additional metadata for the particular execution result.
pagingobject · required
A paging information related to the data presented in the execution result. These paging information are multi-dimensional.

ExecutionResultDataSourceMessage

correlationIdstring · required
Id correlating different pieces of supplementary info together.
sourcestring · required
Information about what part of the system created this piece of supplementary info.
typestring · required
Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.

dataobject
Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.

ExecutionResultGrandTotal

dataobject[] · required
A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.
Example: [[1,2.5],[-1.3,3.14]]
dimensionHeadersobject[] · required
Contains headers for a subset of totalDimensions in which the totals are grand totals.
totalDimensionsstring[] · required
Dimensions of the grand totals.

ExecutionResultHeader

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributeHeader
	type = object · requires: measureHeader
	type = object · requires: totalHeader

Properties for Variant 1:

attributeHeaderobject · required
Header containing the information related to attributes.

ExecutionResultLimitBreak

limitinteger · int64 · required
The configured threshold value.
limitTypestring · required
Type of the limit that was broken, e.g. "rowCount".

valueinteger · int64
The actual value that triggered the limit; null when it cannot be determined exactly.

ExecutionResultMetadata

dataSourceMessagesobject[] · required
Additional information sent by the underlying data source.

limitBreaksobject[]
Limits that were broken during result computation, causing the result to be partial. Absent when the result is complete.

ExecutionResultPaging

countinteger[] · required
A count of the returned results in every dimension.
Example: [2,2]
offsetinteger[] · required
The offset of the results returned in every dimension.
Example: [0,0]
totalinteger[] · required
A total count of the results in every dimension.
Example: [2,2]

ExecutionSettings

dataSamplingPercentagenumber · float
Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.
timestampstring · date-time
Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
timezonestring
Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. "Europe/Prague") or a fixed GMT offset (e.g. "GMT+02:00"). If not set, the time zone from the workspace/user settings is used.
Example: Europe/Prague

ExportRequest

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: dashboardId, fileName
	type = object · requires: fileName, format

Properties for Variant 1:

Export request object describing the export properties and metadata for dashboard PDF exports.

dashboardIdstring · required
Dashboard identifier
Example: 761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0
fileNamestring · required
File name to be used for retrieving the pdf document.
Example: filename

metadataobject
Metadata definition in free-form JSON format.
Example: {}
timezoneIdstring | null
Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.
Example: Asia/Kolkata

ExportResponse

exportResultstring · required

ExportResult

exportIdstring · required
fileNamestring · required
statusstring · enum · required
Enum values:
SUCCESS
ERROR
INTERNAL_ERROR
TIMEOUT

errorMessagestring
expiresAtstring · date-time
fileSizeinteger · int64
fileUristring
finishedAtstring · date-time
traceIdstring
triggeredAtstring · date-time

FailedOperation

idstring · required
Id of the operation
kindstring · enum · required
Type of the long-running operation.
- provision-database — Provisioning of an AI Lake database.
- deprovision-database — Deprovisioning (deletion) of an AI Lake database.
- run-service-command — Running a command in a particular AI Lake service.
- create-pipe-table — Creating a pipe table backed by an S3 data source.
- delete-pipe-table — Deleting a pipe table.
- analyze-statistics — Running ANALYZE TABLE for CBO statistics collection.
- refresh-partition — Refreshing a specific Hive partition (delete + re-load from S3).
Enum values:
provision-database
deprovision-database
run-service-command
create-pipe-table
delete-pipe-table
analyze-statistics
refresh-partition
statusstring · enum · required
Enum values:
failed
errorobject · required
Error information for a failed operation

FeatureFlagsContext

earlyAccessstring · required
earlyAccessValuesstring[] · unique · required

Features

contextobject · required

Feedback

typestring · enum · required
Feedback type.
Enum values:
POSITIVE
NEGATIVE

text
Optional free-form feedback comment.

File

anyobject[]
canResegmentstring · enum
Enum values:
YES
NO
idstring
notesobject
originalstring
otherAttributesobject
skeletonobject
spacestring
srcDirstring · enum
Enum values:
LTR
RTL
AUTO
translatestring · enum
Enum values:
YES
NO
trgDirstring · enum
Enum values:
LTR
RTL
AUTO
unitOrGroupobject[]

Filter

FilterBy

labelTypestring · enum
Specifies which label is used for filtering - primary or requested.
Enum values:
PRIMARY
REQUESTED
Default: REQUESTED

FilterDefinition

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: inline
	type = object · requires: rankingFilter
	type = object · requires: comparisonMeasureValueFilter
	type = object · requires: rangeMeasureValueFilter
	type = object · requires: compoundMeasureValueFilter
	type = object · requires: absoluteDateFilter
	type = object · requires: absoluteGranularityDateFilter
	type = object · requires: relativeDateFilter
	type = object · requires: allTimeDateFilter
	type = object · requires: negativeAttributeFilter
	type = object · requires: positiveAttributeFilter
	type = object · requires: matchAttributeFilter

Properties for InlineFilterDefinition:

Filter in form of direct MAQL query.

inlineobject · required

FilterDefinitionForSimpleMeasure

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object · requires: type, using, state

Properties for Variant 1:

Abstract filter definition type for dates.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: absoluteDateFilter
	type = object · requires: absoluteGranularityDateFilter
	type = object · requires: relativeDateFilter
	type = object · requires: allTimeDateFilter

Properties for AbsoluteDateFilter:

A datetime filter specifying exact from and to values.

absoluteDateFilterobject · required

FiscalYearCalendarDefinition

monthOffsetinteger · int32 · required
Number of months the fiscal year start is shifted relative to the Gregorian year.
Example: 3
typestring · enum · required
Enum values:
fiscalYear

ForecastConfig

confidenceLevelnumber · float · required
Confidence interval boundary value.
forecastPeriodinteger · int32 · required
Number of future periods that should be forecasted
seasonalboolean · required
Whether the input data is seasonal

ForecastRequest

forecastPeriodinteger · int32 · required
Number of future periods that should be forecasted

confidenceLevelnumber · float
Confidence interval boundary value.
Default: 0.95
seasonalboolean
Whether the input data is seasonal
Default: false

ForecastResult

attributestring[] · required
lowerBound(number | null)[] · required
origin(number | null)[] · required
prediction(number | null)[] · required
upperBound(number | null)[] · required

FoundObjects

objectsobject[] · required
List of objects found with a similarity search.

reasoningstring · deprecated · required
DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.

Frequency

bucketsobject[] · required

FrequencyBucket

countinteger · int64 · required

valuestring

FrequencyProperties

valueLimitinteger · int32
The maximum number of distinct values to return.
Default: 10

FunctionCallContent

argumentsobject · required
Function/tool arguments payload.
callIdstring · required
Function call correlation identifier.
idstring · required
Function call item identifier from LLM.
namestring · required
Function/tool name.

typestring · const
Type of item content.
Const value: toolCall
Default: toolCall

FunctionResultContent

callIdstring · required
Function call correlation identifier.
resultstring · required
Serialized function/tool execution result.

typestring · const
Type of item content.
Const value: toolResult
Default: toolResult

GdStorageFile

modifiedAtstring · date-time · required
Last modification timestamp of the file.
namestring · required
Name of the file.
sizeinteger · int64 · required
Size of the file in bytes.
typestring · enum · required
Type of the file.
Enum values:
CSV

GenAiRankingFilter

measuresstring[] · required
operatorstring · enum · required
Enum values:
TOP
BOTTOM
valueinteger · int32 · required

dimensionalitystring[]

GenerateDescriptionRequest

objectIdstring · required
Identifier of the object to describe
objectTypestring · enum · required
Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute
Enum values:
Visualization
Dashboard
Metric
Fact
Attribute

GenerateDescriptionResponse

descriptionstring
Generated description of the requested object
notestring
Additional note with details in case generation was not performed

GenerateLdmRequest

aggregatedFactPrefixstring
Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of separator parameter. Given the aggregated fact prefix is aggr and separator is __, the columns with name like aggr__sum__product__sold will be considered as aggregated sold fact in the product table with SUM aggregate function.
Example: aggr
dateGranularitiesstring
Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is all which enables all available date granularities, including time granularities (like hours, minutes).
Example: all
dateReferencePrefixstring
Columns starting with this prefix will be considered as references to date dataset. The prefix is then followed by the value of separator parameter. Given the reference prefix is d and separator is __, the columns with name like d__date will be considered as reference to date dataset. There can be also second separator and granularity suffix, e.g. d__date__day to create attribute reference to exact date dataset and granularity.
Example: d
denormPrefixstring
Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of separator parameter. Given the denormalization reference prefix is dr and separator is __, the columns with name like dr__customer_name will be considered as denormalization references.
Example: dr
factPrefixstring
Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of separator parameter. Given the fact prefix is f and separator is __, the columns with name like f__sold will be considered as facts.
Example: f
generateLongIdsboolean
A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of <table>.<column> is used. If the flag is set to true, then all ids will be generated in the long form.
Default: false
grainMultivalueReferencePrefixstring
Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of separator parameter. Given the reference prefix is grmr and separator is __, the columns with name like grmr__customer__customer_id will be considered as grain multivalue references to customer_id in customer table.
Example: grmr
grainPrefixstring
Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of separator parameter. Given the grain prefix is gr and separator is __, the columns with name like gr__name will be considered as grains.
Example: gr
grainReferencePrefixstring
Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of separator parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is grr and separator is __, the columns with name like grr__customer__customer_id will be considered as grain references to customer_id in customer table.
Example: grr
multivalueReferencePrefixstring
Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of separator parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is mr and separator is __, the columns with name like mr__customer__customer_id will be considered as multivalue references to customer_id in customer table.
Example: mr
pdmobject
PDM additions wrapper.
primaryLabelPrefixstring
Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of separator parameter. Given the primary label prefix is pl and separator is __, the columns with name like pl__country_id will be considered as primary labels.
Example: pl
referencePrefixstring
Columns starting with this prefix will be considered as references. The prefix is then followed by the value of separator parameter. Given the reference prefix is r and separator is __, the columns with name like r__customer__customer_id will be considered as references to customer_id in customer table.
Example: r
secondaryLabelPrefixstring
Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of separator parameter. Given the secondary label prefix is ls and separator is __, the columns with name like ls__country_id__country_name will be considered as secondary labels.
Example: ls
separatorstring
A separator between prefixes and the names. Default is "__".
Default: __
translationPrefixstring
Columns starting with this prefix will be considered as secondary label translation. The prefix is then followed by the value of separator parameter. Given the translation prefix is tr and separator is __, the columns with name like tr__attribute__label__en-US will be considered as secondary label en-US translation to label label in attribute attribute.
Example: tr
wdfPrefixstring
Column serving as workspace data filter. No labels are auto generated for such columns.
Default: wdf
workspaceIdstring
Optional workspace id.

tablePrefixstring · deprecated · required
Tables starting with this prefix will be included. The prefix is then followed by the value of separator parameter. Given the table prefix is out_table and separator is __, the table with name like out_table__customers will be scanned.
Example: out_table
viewPrefixstring · deprecated · required
Views starting with this prefix will be included. The prefix is then followed by the value of separator parameter. Given the view prefix is out_view and separator is __, the table with name like out_view__us_customers will be scanned.
Example: out_view

GenerateTitleRequest

objectIdstring · required
Identifier of the object to title
objectTypestring · enum · required
Type of the object to title. Matches chat-search object types.
Enum values:
Visualization
Dashboard
Metric
Fact
Attribute

GenerateTitleResponse

notestring
Additional note with details in case generation was not performed
titlestring
Generated title of the requested object

GeoAreaConfig

collectionobject · required

GeoCollectionIdentifier

idstring · maxLength: 255 · required
Geo collection identifier.

kindstring · enum
Type of geo collection.
Enum values:
STATIC
CUSTOM
Default: STATIC

GeoJsonFeature

propertiesobject · required
typestring · required

geometryobject
GeoJSON Geometry
idobject

GeoJsonFeatureCollection

featuresobject[] · required
typestring · required

bboxnumber[]

GeoJsonGeometry

coordinatesobject · required
typestring · required

GetQualityIssuesResponse

issuesobject[] · required
List of quality issues found in the workspace
statusstring · enum · required
Status of the latest triggered quality check process
Enum values:
RUNNING
SYNCING
COMPLETED
FAILED
CANCELLED
NOT_FOUND
DISABLED

updatedAtstring
Timestamp when the quality issues were last updated (ISO format)

GetServiceStatusResponse

statusobject | null · maxLength: 15000 · required
Free-form JSON object
Example: {}

GrainIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Grain ID.
Example: attr.customers.customer_name
typestring · enum · required
A type of the grain.
Enum values:
attribute
date
Example: ATTRIBUTE

GrantedPermission

levelstring · required
Level of permission
Example: VIEW, SHARE, EDIT
sourcestring · required
Source of permission
Example: direct/indirect

GranularitiesFormatting

titleBasestring · maxLength: 255 · required
Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title.
titlePatternstring · maxLength: 255 · required
This pattern is used to generate the title of attributes and labels that result from the granularities. There are two tokens available:
- %titleBase - represents shared part by all titles, or title of Date Dataset if left empty
- %granularityTitle - represents DateGranularity built-in title
Example: %titleBase - %granularityTitle

HTTPValidationError

detailobject[]

HashDistributionConfig

typestring · enum · required
Enum values:
hash

bucketsinteger · int32 · min: 1
Number of hash buckets. Defaults to 1.
columnsstring[]
Columns to distribute by. Defaults to first column.

HeaderGroup

headersobject[] · required
An array containing headers.

HierarchyObjectIdentification

idstring · required
typestring · enum · required
Enum values:
analyticalDashboard
attribute
dashboardPlugin
dataset
fact
label
metric
prompt
Example: metric

Histogram

bucketsobject[] · required

HistogramBucket

countinteger · int64 · required
lowerBoundnumber · double · required
upperBoundnumber · double · required

HistogramProperties

bucketCountinteger · int32 · required

IdentifierDuplications

idstring · required
originsstring[] · required
typestring · enum · required
Enum values:
analyticalDashboard
attribute
dashboardPlugin
dataset
fact
label
metric
prompt
Example: metric

IdentifierRef

identifierobject · required

ImageExportRequest

dashboardIdstring · required
Dashboard identifier
Example: 761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0
fileNamestring · required
File name to be used for retrieving the image document.
Example: filename
formatstring · enum · required
Requested resulting file type.
Enum values:
PNG
Example: PNG
widgetIdsstring[] · minItems: 1 · maxItems: 1 · unique · required
List of widget identifiers to be exported. Note that only one widget is currently supported.

metadataobject | null · maxLength: 15000
Free-form JSON object
Example: {}
timezoneIdstring | null
Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.
Example: Asia/Kolkata

ImportCsvRequest

tablesobject[] · required
Information about the individual tables.

ImportCsvRequestTable

namestring · required
Name of the table.
sourceobject · required
Information about source data for a particular table.

ImportCsvRequestTableSource

configobject · required
Config to use when accessing the data for executions, etc.
locationstring · required
Location of the data in the staging area.

ImportCsvRequestTableSourceConfig

columnDateFormatsobject
Date formats to use to use to read the given columns.
convertOptionsobject
Options for converting CSV files when reading.
parseOptionsobject
Options for parsing CSV files.
readOptionsobject
Options for reading CSV files.

ImportCsvResponse

namestring · required
Name of the table the file was imported to.
versioninteger · int32 · required
Version the file was imported as.

ImportGeoCollectionRequest

locationstring · required
Location of the file in the staging area.

ImportGeoCollectionResponse

versioninteger · int32 · required
The version of the imported geo collection.

InPlatform

typestring · enum · required
The destination type.
Enum values:
IN_PLATFORM

IndefiniteCacheRetention

typestring · enum · required
The cache retention type.
Enum values:
INDEFINITE

InlineFilterDefinition

inlineobject · required

InlineFilterDefinitionBody

filterstring · required

applyOnResult
localIdentifier

InlineMeasureDefinition

inlineobject · required

titlestring · required
Widget title as displayed on the dashboard.
visualizationIdstring · required
Visualization object ID referenced by this insight widget.
widgetIdstring · required
Widget object ID.
widgetTypestring · enum · required
Enum values:
insight

filtersobject[]
Filters currently applied to the dashboard.
resultIdstring
Signed result ID for this widget's cached execution result.

InteractionStepListResponse

stepsobject[] · required
Ordered list of interaction steps.

InteractionStepResponse

conversationIdstring · required
Parent conversation identifier.
createdAtstring · required
Step start timestamp (ISO-8601 UTC).
durationMsinteger · required
Wall-clock duration of the LLM call and its tool dispatches.
responseIdstring · required
Response/turn identifier the step belongs to.
stepIdstring · required
Interaction step identifier.
stepIndexinteger · required
Zero-based step order within the turn.
tokensobject · required
Token usage of the step's LLM call.

IntervalGranularity

string · enum

Enum values:

DAY

WEEK

MONTH

QUARTER

YEAR

Date granularity for the interval of an ONCE_PER_INTERVAL trigger.

IntroSlideTemplate

Invitation

emailstring · email · required
userIdstring · required

firstNamestring
forceSendboolean
Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends)
lastNamestring

IpAllowlistPolicyTargets

targetsobject[] · required

JsonApiAgentIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
agent
Example: agent

attributesobject
relationshipsobject

JsonApiAgentInDocument

dataobject · required
JSON:API representation of agent entity.

JsonApiAgentOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
agent
Example: agent

attributesobject
relationshipsobject

JsonApiAgentOutDocument

dataobject · required
JSON:API representation of agent entity.

includedarray · unique
Included resources
linksobject

JsonApiAgentOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of userGroup entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userGroup
Example: userGroup

attributesobject
relationshipsobject
linksobject

JsonApiAgentOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiAgentOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
agent
Example: agent

attributesobject
relationshipsobject
linksobject

JsonApiAgentPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
agent
Example: agent

attributesobject
relationshipsobject

JsonApiAgentPatchDocument

dataobject · required
JSON:API representation of patching agent entity.

JsonApiAggregatedFactLinkage

idstring · required
typestring · enum · required
Enum values:
aggregatedFact

JsonApiAggregatedFactOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
aggregatedFact
Example: aggregatedFact

metaobject
relationshipsobject

JsonApiAggregatedFactOutDocument

dataobject · required
JSON:API representation of aggregatedFact entity.

includedarray · unique
Included resources
linksobject

JsonApiAggregatedFactOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of attribute entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiAggregatedFactOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiAggregatedFactOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
aggregatedFact
Example: aggregatedFact

metaobject
relationshipsobject
linksobject

JsonApiAggregatedFactToManyLinkage

idstring · required
typestring · enum · required
Enum values:
aggregatedFact

JsonApiAnalyticalDashboardIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

JsonApiAnalyticalDashboardInDocument

dataobject · required
JSON:API representation of analyticalDashboard entity.

JsonApiAnalyticalDashboardLinkage

idstring · required
typestring · enum · required
Enum values:
analyticalDashboard

JsonApiAnalyticalDashboardOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject

JsonApiAnalyticalDashboardOutDocument

dataobject · required
JSON:API representation of analyticalDashboard entity.

includedarray · unique
Included resources
linksobject

JsonApiAnalyticalDashboardOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: attributes, id, type

Properties for Variant 1:

JSON:API representation of analyticalDashboard entity.

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject
linksobject

JsonApiAnalyticalDashboardOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiAnalyticalDashboardOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject
linksobject

JsonApiAnalyticalDashboardPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

JsonApiAnalyticalDashboardPatchDocument

dataobject · required
JSON:API representation of patching analyticalDashboard entity.

JsonApiAnalyticalDashboardPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiAnalyticalDashboardPostOptionalIdDocument

dataobject · required
JSON:API representation of analyticalDashboard entity.

JsonApiAnalyticalDashboardToManyLinkage

idstring · required
typestring · enum · required
Enum values:
analyticalDashboard

JsonApiAnalyticalDashboardToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
analyticalDashboard

JsonApiApiTokenIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
apiToken
Example: apiToken

JsonApiApiTokenInDocument

dataobject · required
JSON:API representation of apiToken entity.

JsonApiApiTokenOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
apiToken
Example: apiToken

attributesobject

JsonApiApiTokenOutDocument

dataobject · required
JSON:API representation of apiToken entity.

linksobject

JsonApiApiTokenOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiApiTokenOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
apiToken
Example: apiToken

attributesobject
linksobject

JsonApiAttributeHierarchyIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attributeHierarchy
Example: attributeHierarchy

attributesobject

JsonApiAttributeHierarchyInDocument

dataobject · required
JSON:API representation of attributeHierarchy entity.

JsonApiAttributeHierarchyLinkage

idstring · required
typestring · enum · required
Enum values:
attributeHierarchy

JsonApiAttributeHierarchyOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attributeHierarchy
Example: attributeHierarchy

attributesobject
metaobject
relationshipsobject

JsonApiAttributeHierarchyOutDocument

dataobject · required
JSON:API representation of attributeHierarchy entity.

includedarray · unique
Included resources
linksobject

JsonApiAttributeHierarchyOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of attribute entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiAttributeHierarchyOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiAttributeHierarchyOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attributeHierarchy
Example: attributeHierarchy

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiAttributeHierarchyPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attributeHierarchy
Example: attributeHierarchy

attributesobject

JsonApiAttributeHierarchyPatchDocument

dataobject · required
JSON:API representation of patching attributeHierarchy entity.

JsonApiAttributeHierarchyToManyLinkage

idstring · required
typestring · enum · required
Enum values:
attributeHierarchy

JsonApiAttributeLinkage

idstring · required
typestring · enum · required
Enum values:
attribute

JsonApiAttributeOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
metaobject
relationshipsobject

JsonApiAttributeOutDocument

dataobject · required
JSON:API representation of attribute entity.

includedarray · unique
Included resources
linksobject

JsonApiAttributeOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of attributeHierarchy entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attributeHierarchy
Example: attributeHierarchy

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiAttributeOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiAttributeOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiAttributePatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
relationshipsobject

JsonApiAttributePatchDocument

dataobject · required
JSON:API representation of patching attribute entity.

JsonApiAttributeToManyLinkage

idstring · required
typestring · enum · required
Enum values:
attribute

JsonApiAttributeToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
attribute

JsonApiAutomationIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
automation
Example: automation

attributesobject
relationshipsobject

JsonApiAutomationInDocument

dataobject · required
JSON:API representation of automation entity.

JsonApiAutomationLinkage

idstring · required
typestring · enum · required
Enum values:
automation

JsonApiAutomationOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
automation
Example: automation

attributesobject
metaobject
relationshipsobject

JsonApiAutomationOutDocument

dataobject · required
JSON:API representation of automation entity.

includedarray · unique
Included resources
linksobject

JsonApiAutomationOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributes, id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of analyticalDashboard entity.

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject
linksobject

JsonApiAutomationOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiAutomationOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
automation
Example: automation

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiAutomationPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
automation
Example: automation

attributesobject
relationshipsobject

JsonApiAutomationPatchDocument

dataobject · required
JSON:API representation of patching automation entity.

JsonApiAutomationResultLinkage

idstring · required
typestring · enum · required
Enum values:
automationResult

JsonApiAutomationResultOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
automationResult
Example: automationResult

relationshipsobject

JsonApiAutomationResultOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiAutomationResultOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
automationResult
Example: automationResult

relationshipsobject
linksobject

JsonApiAutomationResultToManyLinkage

idstring · required
typestring · enum · required
Enum values:
automationResult

JsonApiAutomationToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
automation

JsonApiColorPaletteIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
colorPalette
Example: colorPalette

JsonApiColorPaletteInDocument

dataobject · required
JSON:API representation of colorPalette entity.

JsonApiColorPaletteOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
colorPalette
Example: colorPalette

JsonApiColorPaletteOutDocument

dataobject · required
JSON:API representation of colorPalette entity.

linksobject

JsonApiColorPaletteOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiColorPaletteOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
colorPalette
Example: colorPalette

linksobject

JsonApiColorPalettePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
colorPalette
Example: colorPalette

JsonApiColorPalettePatchDocument

dataobject · required
JSON:API representation of patching colorPalette entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
cookieSecurityConfiguration
Example: cookieSecurityConfiguration

attributesobject

dataobject · required
JSON:API representation of cookieSecurityConfiguration entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
cookieSecurityConfiguration
Example: cookieSecurityConfiguration

attributesobject

dataobject · required
JSON:API representation of cookieSecurityConfiguration entity.

linksobject

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
cookieSecurityConfiguration
Example: cookieSecurityConfiguration

attributesobject

dataobject · required
JSON:API representation of patching cookieSecurityConfiguration entity.

JsonApiCspDirectiveIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
cspDirective
Example: cspDirective

JsonApiCspDirectiveInDocument

dataobject · required
JSON:API representation of cspDirective entity.

JsonApiCspDirectiveOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
cspDirective
Example: cspDirective

JsonApiCspDirectiveOutDocument

dataobject · required
JSON:API representation of cspDirective entity.

linksobject

JsonApiCspDirectiveOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiCspDirectiveOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
cspDirective
Example: cspDirective

linksobject

JsonApiCspDirectivePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
cspDirective
Example: cspDirective

JsonApiCspDirectivePatchDocument

dataobject · required
JSON:API representation of patching cspDirective entity.

JsonApiCustomApplicationSettingIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customApplicationSetting
Example: customApplicationSetting

JsonApiCustomApplicationSettingInDocument

dataobject · required
JSON:API representation of customApplicationSetting entity.

JsonApiCustomApplicationSettingOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customApplicationSetting
Example: customApplicationSetting

metaobject

JsonApiCustomApplicationSettingOutDocument

dataobject · required
JSON:API representation of customApplicationSetting entity.

linksobject

JsonApiCustomApplicationSettingOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiCustomApplicationSettingOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customApplicationSetting
Example: customApplicationSetting

metaobject
linksobject

JsonApiCustomApplicationSettingPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customApplicationSetting
Example: customApplicationSetting

JsonApiCustomApplicationSettingPatchDocument

dataobject · required
JSON:API representation of patching customApplicationSetting entity.

JsonApiCustomApplicationSettingPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
customApplicationSetting
Example: customApplicationSetting

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiCustomApplicationSettingPostOptionalIdDocument

dataobject · required
JSON:API representation of customApplicationSetting entity.

JsonApiCustomGeoCollectionIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customGeoCollection
Example: customGeoCollection

attributesobject

JsonApiCustomGeoCollectionInDocument

dataobject · required
JSON:API representation of customGeoCollection entity.

JsonApiCustomGeoCollectionOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customGeoCollection
Example: customGeoCollection

attributesobject

JsonApiCustomGeoCollectionOutDocument

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

JsonApiCustomGeoCollectionOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiCustomGeoCollectionOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customGeoCollection
Example: customGeoCollection

attributesobject
linksobject

JsonApiCustomGeoCollectionPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customGeoCollection
Example: customGeoCollection

attributesobject

JsonApiCustomGeoCollectionPatchDocument

dataobject · required
JSON:API representation of patching customGeoCollection entity.

JsonApiCustomUserApplicationSettingIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customUserApplicationSetting
Example: customUserApplicationSetting

JsonApiCustomUserApplicationSettingInDocument

dataobject · required
JSON:API representation of customUserApplicationSetting entity.

JsonApiCustomUserApplicationSettingOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customUserApplicationSetting
Example: customUserApplicationSetting

JsonApiCustomUserApplicationSettingOutDocument

dataobject · required
JSON:API representation of customUserApplicationSetting entity.

linksobject

JsonApiCustomUserApplicationSettingOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiCustomUserApplicationSettingOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
customUserApplicationSetting
Example: customUserApplicationSetting

linksobject

JsonApiCustomUserApplicationSettingPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
customUserApplicationSetting
Example: customUserApplicationSetting

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiCustomUserApplicationSettingPostOptionalIdDocument

dataobject · required
JSON:API representation of customUserApplicationSetting entity.

JsonApiDashboardPluginIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dashboardPlugin
Example: dashboardPlugin

attributesobject

JsonApiDashboardPluginInDocument

dataobject · required
JSON:API representation of dashboardPlugin entity.

JsonApiDashboardPluginLinkage

idstring · required
typestring · enum · required
Enum values:
dashboardPlugin

JsonApiDashboardPluginOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dashboardPlugin
Example: dashboardPlugin

attributesobject
metaobject
relationshipsobject

JsonApiDashboardPluginOutDocument

dataobject · required
JSON:API representation of dashboardPlugin entity.

includedobject[] · unique
Included resources
linksobject

JsonApiDashboardPluginOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiDashboardPluginOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dashboardPlugin
Example: dashboardPlugin

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiDashboardPluginPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dashboardPlugin
Example: dashboardPlugin

attributesobject

JsonApiDashboardPluginPatchDocument

dataobject · required
JSON:API representation of patching dashboardPlugin entity.

JsonApiDashboardPluginPostOptionalId

typestring · enum · required
Object type
Enum values:
dashboardPlugin
Example: dashboardPlugin

attributesobject
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiDashboardPluginPostOptionalIdDocument

dataobject · required
JSON:API representation of dashboardPlugin entity.

JsonApiDashboardPluginToManyLinkage

idstring · required
typestring · enum · required
Enum values:
dashboardPlugin

JsonApiDataSourceIdentifierOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataSourceIdentifier
Example: dataSourceIdentifier

metaobject

JsonApiDataSourceIdentifierOutDocument

dataobject · required
JSON:API representation of dataSourceIdentifier entity.

linksobject

JsonApiDataSourceIdentifierOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiDataSourceIdentifierOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataSourceIdentifier
Example: dataSourceIdentifier

metaobject
linksobject

JsonApiDataSourceIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataSource
Example: dataSource

JsonApiDataSourceInDocument

dataobject · required
JSON:API representation of dataSource entity.

JsonApiDataSourceOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataSource
Example: dataSource

metaobject

JsonApiDataSourceOutDocument

dataobject · required
JSON:API representation of dataSource entity.

linksobject

JsonApiDataSourceOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiDataSourceOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataSource
Example: dataSource

metaobject
linksobject

JsonApiDataSourcePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataSource
Example: dataSource

JsonApiDataSourcePatchDocument

dataobject · required
JSON:API representation of patching dataSource entity.

JsonApiDatasetLinkage

idstring · required
typestring · enum · required
Enum values:
dataset

JsonApiDatasetOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataset
Example: dataset

metaobject
relationshipsobject

JsonApiDatasetOutDocument

dataobject · required
JSON:API representation of dataset entity.

includedarray · unique
Included resources
linksobject

JsonApiDatasetOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of aggregatedFact entity.

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
aggregatedFact
Example: aggregatedFact

metaobject
relationshipsobject
linksobject

JsonApiDatasetOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiDatasetOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataset
Example: dataset

metaobject
relationshipsobject
linksobject

JsonApiDatasetPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
dataset
Example: dataset

attributesobject

JsonApiDatasetPatchDocument

dataobject · required
JSON:API representation of patching dataset entity.

JsonApiDatasetToManyLinkage

idstring · required
typestring · enum · required
Enum values:
dataset

JsonApiDatasetToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
dataset

JsonApiDocumentDatabaseInstance

dataobject · required
A single JSON:API resource item
linksobject · required
Links object for a list response

JsonApiDocumentPipeTable

dataobject · required
A single JSON:API resource item
linksobject · required
Links object for a list response

JsonApiEntitlementOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
entitlement
Example: entitlement

attributesobject

JsonApiEntitlementOutDocument

dataobject · required
JSON:API representation of entitlement entity.

linksobject

JsonApiEntitlementOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiEntitlementOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
entitlement
Example: entitlement

attributesobject
linksobject

JsonApiExportDefinitionIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportDefinition
Example: exportDefinition

attributesobject
relationshipsobject

JsonApiExportDefinitionInDocument

dataobject · required
JSON:API representation of exportDefinition entity.

JsonApiExportDefinitionLinkage

idstring · required
typestring · enum · required
Enum values:
exportDefinition

JsonApiExportDefinitionOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportDefinition
Example: exportDefinition

attributesobject
metaobject
relationshipsobject

JsonApiExportDefinitionOutDocument

dataobject · required
JSON:API representation of exportDefinition entity.

includedarray · unique
Included resources
linksobject

JsonApiExportDefinitionOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: attributes, id, type

Properties for Variant 1:

JSON:API representation of analyticalDashboard entity.

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject
linksobject

JsonApiExportDefinitionOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiExportDefinitionOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportDefinition
Example: exportDefinition

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiExportDefinitionPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportDefinition
Example: exportDefinition

attributesobject
relationshipsobject

JsonApiExportDefinitionPatchDocument

dataobject · required
JSON:API representation of patching exportDefinition entity.

JsonApiExportDefinitionPostOptionalId

typestring · enum · required
Object type
Enum values:
exportDefinition
Example: exportDefinition

attributesobject
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1
relationshipsobject

JsonApiExportDefinitionPostOptionalIdDocument

dataobject · required
JSON:API representation of exportDefinition entity.

JsonApiExportDefinitionToManyLinkage

idstring · required
typestring · enum · required
Enum values:
exportDefinition

JsonApiExportTemplateIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportTemplate
Example: exportTemplate

JsonApiExportTemplateInDocument

dataobject · required
JSON:API representation of exportTemplate entity.

JsonApiExportTemplateOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportTemplate
Example: exportTemplate

JsonApiExportTemplateOutDocument

dataobject · required
JSON:API representation of exportTemplate entity.

linksobject

JsonApiExportTemplateOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiExportTemplateOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportTemplate
Example: exportTemplate

linksobject

JsonApiExportTemplatePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
exportTemplate
Example: exportTemplate

JsonApiExportTemplatePatchDocument

dataobject · required
JSON:API representation of patching exportTemplate entity.

JsonApiExportTemplatePostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
exportTemplate
Example: exportTemplate

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiExportTemplatePostOptionalIdDocument

dataobject · required
JSON:API representation of exportTemplate entity.

JsonApiFactLinkage

idstring · required
typestring · enum · required
Enum values:
fact

JsonApiFactOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
fact
Example: fact

attributesobject
metaobject
relationshipsobject

JsonApiFactOutDocument

dataobject · required
JSON:API representation of fact entity.

includedobject[] · unique
Included resources
linksobject

JsonApiFactOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiFactOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
fact
Example: fact

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiFactPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
fact
Example: fact

attributesobject

JsonApiFactPatchDocument

dataobject · required
JSON:API representation of patching fact entity.

JsonApiFactToManyLinkage

idstring · required
typestring · enum · required
Enum values:
fact

JsonApiFactToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
fact

JsonApiFilterContextIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterContext
Example: filterContext

JsonApiFilterContextInDocument

dataobject · required
JSON:API representation of filterContext entity.

JsonApiFilterContextLinkage

idstring · required
typestring · enum · required
Enum values:
filterContext

JsonApiFilterContextOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterContext
Example: filterContext

metaobject
relationshipsobject

JsonApiFilterContextOutDocument

dataobject · required
JSON:API representation of filterContext entity.

includedarray · unique
Included resources
linksobject

JsonApiFilterContextOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of attribute entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiFilterContextOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiFilterContextOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterContext
Example: filterContext

metaobject
relationshipsobject
linksobject

JsonApiFilterContextPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterContext
Example: filterContext

JsonApiFilterContextPatchDocument

dataobject · required
JSON:API representation of patching filterContext entity.

JsonApiFilterContextPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
filterContext
Example: filterContext

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiFilterContextPostOptionalIdDocument

dataobject · required
JSON:API representation of filterContext entity.

JsonApiFilterContextToManyLinkage

idstring · required
typestring · enum · required
Enum values:
filterContext

JsonApiFilterViewIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterView
Example: filterView

relationshipsobject

JsonApiFilterViewInDocument

dataobject · required
JSON:API representation of filterView entity.

JsonApiFilterViewOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterView
Example: filterView

relationshipsobject

JsonApiFilterViewOutDocument

dataobject · required
JSON:API representation of filterView entity.

includedarray · unique
Included resources
linksobject

JsonApiFilterViewOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributes, id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of analyticalDashboard entity.

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject
linksobject

JsonApiFilterViewOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiFilterViewOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterView
Example: filterView

relationshipsobject
linksobject

JsonApiFilterViewPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
filterView
Example: filterView

relationshipsobject

JsonApiFilterViewPatchDocument

dataobject · required
JSON:API representation of patching filterView entity.

JsonApiFiscalCalendarOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
fiscalCalendar
Example: fiscalCalendar

attributesobject

JsonApiFiscalCalendarOutDocument

dataobject · required
A custom fiscal calendar.

linksobject

JsonApiFiscalCalendarOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiFiscalCalendarOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
fiscalCalendar
Example: fiscalCalendar

attributesobject
linksobject

JsonApiIdentityProviderIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
identityProvider
Example: identityProvider

attributesobject

JsonApiIdentityProviderInDocument

dataobject · required
JSON:API representation of identityProvider entity.

JsonApiIdentityProviderLinkage

idstring · required
typestring · enum · required
Enum values:
identityProvider

JsonApiIdentityProviderOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
identityProvider
Example: identityProvider

attributesobject

JsonApiIdentityProviderOutDocument

dataobject · required
JSON:API representation of identityProvider entity.

linksobject

JsonApiIdentityProviderOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiIdentityProviderOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
identityProvider
Example: identityProvider

attributesobject
linksobject

JsonApiIdentityProviderPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
identityProvider
Example: identityProvider

attributesobject

JsonApiIdentityProviderPatchDocument

dataobject · required
JSON:API representation of patching identityProvider entity.

JsonApiIdentityProviderToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
identityProvider

JsonApiIpAllowlistPolicyIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
ipAllowlistPolicy
Example: ipAllowlistPolicy

relationshipsobject

JsonApiIpAllowlistPolicyInDocument

dataobject · required
JSON:API representation of ipAllowlistPolicy entity.

JsonApiIpAllowlistPolicyOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
ipAllowlistPolicy
Example: ipAllowlistPolicy

relationshipsobject

JsonApiIpAllowlistPolicyOutDocument

dataobject · required
JSON:API representation of ipAllowlistPolicy entity.

includedarray · unique
Included resources
linksobject

JsonApiIpAllowlistPolicyOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of user entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
user
Example: user

attributesobject
relationshipsobject
linksobject

JsonApiIpAllowlistPolicyOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiIpAllowlistPolicyOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
ipAllowlistPolicy
Example: ipAllowlistPolicy

relationshipsobject
linksobject

JsonApiItemDataSourceInfo

attributesobject · required
A single data source association for an AI Lake Database instance
idstring · required
Resource identifier
typestring · required
Resource type

JsonApiItemDatabaseInstance

attributesobject · required
A single AI Lake Database instance
idstring · required
Resource identifier
typestring · required
Resource type

JsonApiItemObjectStorageInfo

attributesobject · required
Descriptor of a registered ObjectStorage. Provider credentials are stripped — only fields useful for identifying the storage are returned.
idstring · required
Resource identifier
typestring · required
Resource type

JsonApiItemPipeTable

attributesobject · required
Full details of a pipe-backed OLAP table
idstring · required
Resource identifier
typestring · required
Resource type

JsonApiItemPipeTableSummary

attributesobject · required
Lightweight pipe table entry used in list responses
idstring · required
Resource identifier
typestring · required
Resource type

JsonApiItemServiceInfo

attributesobject · required
Non-sensitive metadata for an AI Lake pipeline
idstring · required
Resource identifier
typestring · required
Resource type

JsonApiJwkIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
jwk
Example: jwk

attributesobject

JsonApiJwkInDocument

dataobject · required
JSON:API representation of jwk entity.

JsonApiJwkOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
jwk
Example: jwk

attributesobject

JsonApiJwkOutDocument

dataobject · required
JSON:API representation of jwk entity.

linksobject

JsonApiJwkOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiJwkOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
jwk
Example: jwk

attributesobject
linksobject

JsonApiJwkPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
jwk
Example: jwk

attributesobject

JsonApiJwkPatchDocument

dataobject · required
JSON:API representation of patching jwk entity.

JsonApiKnowledgeRecommendationIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
relationshipsobject · required
typestring · enum · required
Object type
Enum values:
knowledgeRecommendation
Example: knowledgeRecommendation

JsonApiKnowledgeRecommendationInDocument

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

JsonApiKnowledgeRecommendationOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
knowledgeRecommendation
Example: knowledgeRecommendation

metaobject
relationshipsobject

JsonApiKnowledgeRecommendationOutDocument

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

includedarray · unique
Included resources
linksobject

JsonApiKnowledgeRecommendationOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributes, id, type
	type = object · requires: attributes, id, type

Properties for Variant 1:

JSON:API representation of analyticalDashboard entity.

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject
linksobject

JsonApiKnowledgeRecommendationOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiKnowledgeRecommendationOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
knowledgeRecommendation
Example: knowledgeRecommendation

metaobject
relationshipsobject
linksobject

JsonApiKnowledgeRecommendationPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
relationshipsobject · required
typestring · enum · required
Object type
Enum values:
knowledgeRecommendation
Example: knowledgeRecommendation

JsonApiKnowledgeRecommendationPatchDocument

dataobject · required
JSON:API representation of patching knowledgeRecommendation entity.

JsonApiKnowledgeRecommendationPostOptionalId

attributesobject · required
relationshipsobject · required
typestring · enum · required
Object type
Enum values:
knowledgeRecommendation
Example: knowledgeRecommendation

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiKnowledgeRecommendationPostOptionalIdDocument

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

JsonApiLabelLinkage

idstring · required
typestring · enum · required
Enum values:
label

JsonApiLabelOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
label
Example: label

attributesobject
metaobject
relationshipsobject

JsonApiLabelOutDocument

dataobject · required
JSON:API representation of label entity.

includedobject[] · unique
Included resources
linksobject

JsonApiLabelOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiLabelOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
label
Example: label

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiLabelPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
label
Example: label

attributesobject

JsonApiLabelPatchDocument

dataobject · required
JSON:API representation of patching label entity.

JsonApiLabelToManyLinkage

idstring · required
typestring · enum · required
Enum values:
label

JsonApiLabelToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
label

JsonApiListDocumentDataSourceInfo

dataobject[] · required
Array of resource items
linksobject · required
Links object for a list response

metaobject
Metadata for a paginated list response

JsonApiListDocumentDatabaseInstance

dataobject[] · required
Array of resource items
linksobject · required
Links object for a list response

metaobject
Metadata for a paginated list response

JsonApiListDocumentObjectStorageInfo

dataobject[] · required
Array of resource items
linksobject · required
Links object for a list response

metaobject
Metadata for a paginated list response

JsonApiListDocumentPipeTableSummary

dataobject[] · required
Array of resource items
linksobject · required
Links object for a list response

metaobject
Metadata for a paginated list response

JsonApiListDocumentServiceInfo

dataobject[] · required
Array of resource items
linksobject · required
Links object for a list response

metaobject
Metadata for a paginated list response

JsonApiListLinks

selfstring · required
The URL of this response

JsonApiListMeta

pageobject · required
Pagination information

JsonApiLlmProviderIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
llmProvider
Example: llmProvider

attributesobject

JsonApiLlmProviderInDocument

dataobject · required
LLM Provider configuration for connecting to LLM services.

JsonApiLlmProviderOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
llmProvider
Example: llmProvider

attributesobject

JsonApiLlmProviderOutDocument

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

JsonApiLlmProviderOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiLlmProviderOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
llmProvider
Example: llmProvider

attributesobject
linksobject

JsonApiLlmProviderPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
llmProvider
Example: llmProvider

attributesobject

JsonApiLlmProviderPatchDocument

dataobject · required
LLM Provider configuration for connecting to LLM services.

JsonApiMemoryItemIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
memoryItem
Example: memoryItem

JsonApiMemoryItemInDocument

dataobject · required
JSON:API representation of memoryItem entity.

JsonApiMemoryItemOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
memoryItem
Example: memoryItem

metaobject
relationshipsobject

JsonApiMemoryItemOutDocument

dataobject · required
JSON:API representation of memoryItem entity.

includedobject[] · unique
Included resources
linksobject

JsonApiMemoryItemOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiMemoryItemOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
memoryItem
Example: memoryItem

metaobject
relationshipsobject
linksobject

JsonApiMemoryItemPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
memoryItem
Example: memoryItem

JsonApiMemoryItemPatchDocument

dataobject · required
JSON:API representation of patching memoryItem entity.

JsonApiMemoryItemPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
memoryItem
Example: memoryItem

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiMemoryItemPostOptionalIdDocument

dataobject · required
JSON:API representation of memoryItem entity.

JsonApiMetricIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
metric
Example: metric

JsonApiMetricInDocument

dataobject · required
JSON:API representation of metric entity.

JsonApiMetricLinkage

idstring · required
typestring · enum · required
Enum values:
metric

JsonApiMetricOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
metric
Example: metric

metaobject
relationshipsobject

JsonApiMetricOutDocument

dataobject · required
JSON:API representation of metric entity.

includedarray · unique
Included resources
linksobject

JsonApiMetricOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of attribute entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiMetricOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiMetricOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
metric
Example: metric

metaobject
relationshipsobject
linksobject

JsonApiMetricPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
metric
Example: metric

JsonApiMetricPatchDocument

dataobject · required
JSON:API representation of patching metric entity.

JsonApiMetricPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
metric
Example: metric

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiMetricPostOptionalIdDocument

dataobject · required
JSON:API representation of metric entity.

JsonApiMetricToManyLinkage

idstring · required
typestring · enum · required
Enum values:
metric

JsonApiMetricToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
metric

JsonApiNotificationChannelIdentifierOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
notificationChannelIdentifier
Example: notificationChannelIdentifier

attributesobject

JsonApiNotificationChannelIdentifierOutDocument

dataobject · required
JSON:API representation of notificationChannelIdentifier entity.

linksobject

JsonApiNotificationChannelIdentifierOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiNotificationChannelIdentifierOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
notificationChannelIdentifier
Example: notificationChannelIdentifier

attributesobject
linksobject

JsonApiNotificationChannelIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
notificationChannel
Example: notificationChannel

attributesobject

JsonApiNotificationChannelInDocument

dataobject · required
JSON:API representation of notificationChannel entity.

JsonApiNotificationChannelLinkage

idstring · required
typestring · enum · required
Enum values:
notificationChannel

JsonApiNotificationChannelOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
notificationChannel
Example: notificationChannel

attributesobject

JsonApiNotificationChannelOutDocument

dataobject · required
JSON:API representation of notificationChannel entity.

linksobject

JsonApiNotificationChannelOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiNotificationChannelOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
notificationChannel
Example: notificationChannel

attributesobject
linksobject

JsonApiNotificationChannelPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
notificationChannel
Example: notificationChannel

attributesobject

JsonApiNotificationChannelPatchDocument

dataobject · required
JSON:API representation of patching notificationChannel entity.

JsonApiNotificationChannelPostOptionalId

typestring · enum · required
Object type
Enum values:
notificationChannel
Example: notificationChannel

attributesobject
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiNotificationChannelPostOptionalIdDocument

dataobject · required
JSON:API representation of notificationChannel entity.

JsonApiNotificationChannelToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
notificationChannel

JsonApiOrgMemoryItemIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
orgMemoryItem
Example: orgMemoryItem

JsonApiOrgMemoryItemInDocument

dataobject · required
Organization-scoped AI memory item.

JsonApiOrgMemoryItemOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
orgMemoryItem
Example: orgMemoryItem

relationshipsobject

JsonApiOrgMemoryItemOutDocument

dataobject · required
Organization-scoped AI memory item.

includedobject[] · unique
Included resources
linksobject

JsonApiOrgMemoryItemOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiOrgMemoryItemOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
orgMemoryItem
Example: orgMemoryItem

relationshipsobject
linksobject

JsonApiOrgMemoryItemPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
orgMemoryItem
Example: orgMemoryItem

JsonApiOrgMemoryItemPatchDocument

dataobject · required
Organization-scoped AI memory item.

JsonApiOrganizationIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
organization
Example: organization

attributesobject
relationshipsobject

JsonApiOrganizationInDocument

dataobject · required
JSON:API representation of organization entity.

JsonApiOrganizationOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
organization
Example: organization

attributesobject
metaobject
relationshipsobject

JsonApiOrganizationOutDocument

dataobject · required
JSON:API representation of organization entity.

includedarray · unique
Included resources
linksobject

JsonApiOrganizationOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of identityProvider entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
identityProvider
Example: identityProvider

attributesobject
linksobject

JsonApiOrganizationPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
organization
Example: organization

attributesobject
relationshipsobject

JsonApiOrganizationPatchDocument

dataobject · required
JSON:API representation of patching organization entity.

JsonApiOrganizationSettingIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
organizationSetting
Example: organizationSetting

attributesobject

JsonApiOrganizationSettingInDocument

dataobject · required
JSON:API representation of organizationSetting entity.

JsonApiOrganizationSettingOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
organizationSetting
Example: organizationSetting

attributesobject

JsonApiOrganizationSettingOutDocument

dataobject · required
JSON:API representation of organizationSetting entity.

linksobject

JsonApiOrganizationSettingOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiOrganizationSettingOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
organizationSetting
Example: organizationSetting

attributesobject
linksobject

JsonApiOrganizationSettingPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
organizationSetting
Example: organizationSetting

attributesobject

JsonApiOrganizationSettingPatchDocument

dataobject · required
JSON:API representation of patching organizationSetting entity.

JsonApiPageInfo

numberinteger · int32 · required
Zero-based page number
sizeinteger · int32 · required
Page size

totalElementsinteger · int32
Total number of elements; only present when metaInclude=page was requested
totalPagesinteger · int32
Total number of pages; only present when metaInclude=page was requested

JsonApiParameterIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
parameter
Example: parameter

JsonApiParameterInDocument

dataobject · required
JSON:API representation of parameter entity.

JsonApiParameterLinkage

idstring · required
typestring · enum · required
Enum values:
parameter

JsonApiParameterOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
parameter
Example: parameter

metaobject
relationshipsobject

JsonApiParameterOutDocument

dataobject · required
JSON:API representation of parameter entity.

includedobject[] · unique
Included resources
linksobject

JsonApiParameterOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiParameterOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
parameter
Example: parameter

metaobject
relationshipsobject
linksobject

JsonApiParameterPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
parameter
Example: parameter

JsonApiParameterPatchDocument

dataobject · required
JSON:API representation of patching parameter entity.

JsonApiParameterPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
parameter
Example: parameter

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiParameterPostOptionalIdDocument

dataobject · required
JSON:API representation of parameter entity.

JsonApiParameterToManyLinkage

idstring · required
typestring · enum · required
Enum values:
parameter

JsonApiThemeIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
theme
Example: theme

JsonApiThemeInDocument

dataobject · required
JSON:API representation of theme entity.

JsonApiThemeOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
theme
Example: theme

JsonApiThemeOutDocument

dataobject · required
JSON:API representation of theme entity.

linksobject

JsonApiThemeOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiThemeOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
theme
Example: theme

linksobject

JsonApiThemePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
theme
Example: theme

JsonApiThemePatchDocument

dataobject · required
JSON:API representation of patching theme entity.

JsonApiUserDataFilterIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userDataFilter
Example: userDataFilter

relationshipsobject

JsonApiUserDataFilterInDocument

dataobject · required
JSON:API representation of userDataFilter entity.

JsonApiUserDataFilterOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userDataFilter
Example: userDataFilter

metaobject
relationshipsobject

JsonApiUserDataFilterOutDocument

dataobject · required
JSON:API representation of userDataFilter entity.

includedarray · unique
Included resources
linksobject

JsonApiUserDataFilterOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: attributes, id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of attribute entity.

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
attribute
Example: attribute

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiUserDataFilterOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiUserDataFilterOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userDataFilter
Example: userDataFilter

metaobject
relationshipsobject
linksobject

JsonApiUserDataFilterPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userDataFilter
Example: userDataFilter

relationshipsobject

JsonApiUserDataFilterPatchDocument

dataobject · required
JSON:API representation of patching userDataFilter entity.

JsonApiUserDataFilterPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
userDataFilter
Example: userDataFilter

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1
relationshipsobject

JsonApiUserDataFilterPostOptionalIdDocument

dataobject · required
JSON:API representation of userDataFilter entity.

JsonApiUserGroupIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userGroup
Example: userGroup

attributesobject
relationshipsobject

JsonApiUserGroupInDocument

dataobject · required
JSON:API representation of userGroup entity.

JsonApiUserGroupLinkage

idstring · required
typestring · enum · required
Enum values:
userGroup

JsonApiUserGroupOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userGroup
Example: userGroup

attributesobject
relationshipsobject

JsonApiUserGroupOutDocument

dataobject · required
JSON:API representation of userGroup entity.

includedobject[] · unique
Included resources
linksobject

JsonApiUserGroupOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiUserGroupOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userGroup
Example: userGroup

attributesobject
relationshipsobject
linksobject

JsonApiUserGroupPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userGroup
Example: userGroup

attributesobject
relationshipsobject

JsonApiUserGroupPatchDocument

dataobject · required
JSON:API representation of patching userGroup entity.

JsonApiUserGroupToManyLinkage

idstring · required
typestring · enum · required
Enum values:
userGroup

JsonApiUserGroupToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
userGroup

JsonApiUserIdentifierLinkage

idstring · required
typestring · enum · required
Enum values:
userIdentifier

JsonApiUserIdentifierOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userIdentifier
Example: userIdentifier

attributesobject

JsonApiUserIdentifierOutDocument

dataobject · required
JSON:API representation of userIdentifier entity.

linksobject

JsonApiUserIdentifierOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiUserIdentifierOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userIdentifier
Example: userIdentifier

attributesobject
linksobject

JsonApiUserIdentifierToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
userIdentifier

JsonApiUserIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
user
Example: user

attributesobject
relationshipsobject

JsonApiUserInDocument

dataobject · required
JSON:API representation of user entity.

JsonApiUserLinkage

idstring · required
typestring · enum · required
Enum values:
user

JsonApiUserOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
user
Example: user

attributesobject
relationshipsobject

JsonApiUserOutDocument

dataobject · required
JSON:API representation of user entity.

includedobject[] · unique
Included resources
linksobject

JsonApiUserOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiUserOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
user
Example: user

attributesobject
relationshipsobject
linksobject

JsonApiUserPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
user
Example: user

attributesobject
relationshipsobject

JsonApiUserPatchDocument

dataobject · required
JSON:API representation of patching user entity.

JsonApiUserSettingIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userSetting
Example: userSetting

attributesobject

JsonApiUserSettingInDocument

dataobject · required
JSON:API representation of userSetting entity.

JsonApiUserSettingOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userSetting
Example: userSetting

attributesobject

JsonApiUserSettingOutDocument

dataobject · required
JSON:API representation of userSetting entity.

linksobject

JsonApiUserSettingOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiUserSettingOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
userSetting
Example: userSetting

attributesobject
linksobject

JsonApiUserToManyLinkage

idstring · required
typestring · enum · required
Enum values:
user

JsonApiUserToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
user

JsonApiVisualizationObjectIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
visualizationObject
Example: visualizationObject

JsonApiVisualizationObjectInDocument

dataobject · required
JSON:API representation of visualizationObject entity.

JsonApiVisualizationObjectLinkage

idstring · required
typestring · enum · required
Enum values:
visualizationObject

JsonApiVisualizationObjectOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
visualizationObject
Example: visualizationObject

metaobject
relationshipsobject

JsonApiVisualizationObjectOutDocument

dataobject · required
JSON:API representation of visualizationObject entity.

includedarray · unique
Included resources
linksobject

JsonApiVisualizationObjectOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiVisualizationObjectOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
visualizationObject
Example: visualizationObject

metaobject
relationshipsobject
linksobject

JsonApiVisualizationObjectPatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
visualizationObject
Example: visualizationObject

JsonApiVisualizationObjectPatchDocument

dataobject · required
JSON:API representation of patching visualizationObject entity.

JsonApiVisualizationObjectPostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
visualizationObject
Example: visualizationObject

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiVisualizationObjectPostOptionalIdDocument

dataobject · required
JSON:API representation of visualizationObject entity.

JsonApiVisualizationObjectToManyLinkage

idstring · required
typestring · enum · required
Enum values:
visualizationObject

JsonApiVisualizationObjectToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
visualizationObject

JsonApiWorkspaceAutomationOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceAutomation
Example: workspaceAutomation

attributesobject
relationshipsobject

JsonApiWorkspaceAutomationOutIncludes

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: attributes, id, type
	type = object · requires: attributes, id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: id, type
	type = object · requires: id, type

Properties for Variant 1:

JSON:API representation of analyticalDashboard entity.

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
analyticalDashboard
Example: analyticalDashboard

metaobject
relationshipsobject
linksobject

JsonApiWorkspaceAutomationOutList

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

JsonApiWorkspaceAutomationOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceAutomation
Example: workspaceAutomation

attributesobject
relationshipsobject
linksobject

JsonApiWorkspaceColorPaletteIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceColorPalette
Example: workspaceColorPalette

JsonApiWorkspaceColorPaletteInDocument

dataobject · required
JSON:API representation of workspaceColorPalette entity.

JsonApiWorkspaceColorPaletteOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceColorPalette
Example: workspaceColorPalette

metaobject

JsonApiWorkspaceColorPaletteOutDocument

dataobject · required
JSON:API representation of workspaceColorPalette entity.

linksobject

JsonApiWorkspaceColorPaletteOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiWorkspaceColorPaletteOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceColorPalette
Example: workspaceColorPalette

metaobject
linksobject

JsonApiWorkspaceColorPalettePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceColorPalette
Example: workspaceColorPalette

JsonApiWorkspaceColorPalettePatchDocument

dataobject · required
JSON:API representation of patching workspaceColorPalette entity.

JsonApiWorkspaceDataFilterIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilter
Example: workspaceDataFilter

attributesobject
relationshipsobject

JsonApiWorkspaceDataFilterInDocument

dataobject · required
JSON:API representation of workspaceDataFilter entity.

JsonApiWorkspaceDataFilterLinkage

idstring · required
typestring · enum · required
Enum values:
workspaceDataFilter

JsonApiWorkspaceDataFilterOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilter
Example: workspaceDataFilter

attributesobject
metaobject
relationshipsobject

JsonApiWorkspaceDataFilterOutDocument

dataobject · required
JSON:API representation of workspaceDataFilter entity.

includedobject[] · unique
Included resources
linksobject

JsonApiWorkspaceDataFilterOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiWorkspaceDataFilterOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilter
Example: workspaceDataFilter

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiWorkspaceDataFilterPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilter
Example: workspaceDataFilter

attributesobject
relationshipsobject

JsonApiWorkspaceDataFilterPatchDocument

dataobject · required
JSON:API representation of patching workspaceDataFilter entity.

JsonApiWorkspaceDataFilterSettingIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilterSetting
Example: workspaceDataFilterSetting

attributesobject
relationshipsobject

JsonApiWorkspaceDataFilterSettingInDocument

dataobject · required
JSON:API representation of workspaceDataFilterSetting entity.

JsonApiWorkspaceDataFilterSettingLinkage

idstring · required
typestring · enum · required
Enum values:
workspaceDataFilterSetting

JsonApiWorkspaceDataFilterSettingOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilterSetting
Example: workspaceDataFilterSetting

attributesobject
metaobject
relationshipsobject

JsonApiWorkspaceDataFilterSettingOutDocument

dataobject · required
JSON:API representation of workspaceDataFilterSetting entity.

includedobject[] · unique
Included resources
linksobject

JsonApiWorkspaceDataFilterSettingOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiWorkspaceDataFilterSettingOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilterSetting
Example: workspaceDataFilterSetting

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiWorkspaceDataFilterSettingPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceDataFilterSetting
Example: workspaceDataFilterSetting

attributesobject
relationshipsobject

JsonApiWorkspaceDataFilterSettingPatchDocument

dataobject · required
JSON:API representation of patching workspaceDataFilterSetting entity.

JsonApiWorkspaceDataFilterSettingToManyLinkage

idstring · required
typestring · enum · required
Enum values:
workspaceDataFilterSetting

JsonApiWorkspaceDataFilterToManyLinkage

idstring · required
typestring · enum · required
Enum values:
workspaceDataFilter

JsonApiWorkspaceDataFilterToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
workspaceDataFilter

JsonApiWorkspaceExportTemplateIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceExportTemplate
Example: workspaceExportTemplate

JsonApiWorkspaceExportTemplateInDocument

dataobject · required
JSON:API representation of workspaceExportTemplate entity.

JsonApiWorkspaceExportTemplateOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceExportTemplate
Example: workspaceExportTemplate

metaobject

JsonApiWorkspaceExportTemplateOutDocument

dataobject · required
JSON:API representation of workspaceExportTemplate entity.

linksobject

JsonApiWorkspaceExportTemplateOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiWorkspaceExportTemplateOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceExportTemplate
Example: workspaceExportTemplate

metaobject
linksobject

JsonApiWorkspaceExportTemplatePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceExportTemplate
Example: workspaceExportTemplate

JsonApiWorkspaceExportTemplatePatchDocument

dataobject · required
JSON:API representation of patching workspaceExportTemplate entity.

JsonApiWorkspaceExportTemplatePostOptionalId

attributesobject · required
typestring · enum · required
Object type
Enum values:
workspaceExportTemplate
Example: workspaceExportTemplate

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiWorkspaceExportTemplatePostOptionalIdDocument

dataobject · required
JSON:API representation of workspaceExportTemplate entity.

JsonApiWorkspaceIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspace
Example: workspace

attributesobject
relationshipsobject

JsonApiWorkspaceInDocument

dataobject · required
JSON:API representation of workspace entity.

JsonApiWorkspaceLinkage

idstring · required
typestring · enum · required
Enum values:
workspace

JsonApiWorkspaceOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspace
Example: workspace

attributesobject
metaobject
relationshipsobject

JsonApiWorkspaceOutDocument

dataobject · required
JSON:API representation of workspace entity.

includedobject[] · unique
Included resources
linksobject

JsonApiWorkspaceOutList

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

JsonApiWorkspaceOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspace
Example: workspace

attributesobject
metaobject
relationshipsobject
linksobject

JsonApiWorkspacePatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspace
Example: workspace

attributesobject
relationshipsobject

JsonApiWorkspacePatchDocument

dataobject · required
JSON:API representation of patching workspace entity.

JsonApiWorkspaceSettingIn

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceSetting
Example: workspaceSetting

attributesobject

JsonApiWorkspaceSettingInDocument

dataobject · required
JSON:API representation of workspaceSetting entity.

JsonApiWorkspaceSettingOut

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceSetting
Example: workspaceSetting

attributesobject
metaobject

JsonApiWorkspaceSettingOutDocument

dataobject · required
JSON:API representation of workspaceSetting entity.

linksobject

JsonApiWorkspaceSettingOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiWorkspaceSettingOutWithLinks

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceSetting
Example: workspaceSetting

attributesobject
metaobject
linksobject

JsonApiWorkspaceSettingPatch

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceSetting
Example: workspaceSetting

attributesobject

JsonApiWorkspaceSettingPatchDocument

dataobject · required
JSON:API representation of patching workspaceSetting entity.

JsonApiWorkspaceSettingPostOptionalId

typestring · enum · required
Object type
Enum values:
workspaceSetting
Example: workspaceSetting

attributesobject
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-…
API identifier of an object
Example: id1

JsonApiWorkspaceSettingPostOptionalIdDocument

dataobject · required
JSON:API representation of workspaceSetting entity.

JsonApiWorkspaceThemeIn

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceTheme
Example: workspaceTheme

JsonApiWorkspaceThemeInDocument

dataobject · required
JSON:API representation of workspaceTheme entity.

JsonApiWorkspaceThemeOut

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceTheme
Example: workspaceTheme

metaobject

JsonApiWorkspaceThemeOutDocument

dataobject · required
JSON:API representation of workspaceTheme entity.

linksobject

JsonApiWorkspaceThemeOutList

dataobject[] · unique · required

linksobject
metaobject

JsonApiWorkspaceThemeOutWithLinks

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceTheme
Example: workspaceTheme

metaobject
linksobject

JsonApiWorkspaceThemePatch

attributesobject · required
idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
API identifier of an object
Example: id1
typestring · enum · required
Object type
Enum values:
workspaceTheme
Example: workspaceTheme

JsonApiWorkspaceThemePatchDocument

dataobject · required
JSON:API representation of patching workspaceTheme entity.

JsonApiWorkspaceToOneLinkage

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type

Properties for Variant 1:

The \"type\" and \"id\" to non-empty members.

idstring · required
typestring · enum · required
Enum values:
workspace

JsonNode

KeyConfig

typestring · required

KeyDriverAnalysis

analyzedPeriodstring · required
Analyzed period identifier.
dateAttributeIdstring · required
Date attribute identifier used for period comparison.
filtersobject[] · required
Filters applied to analysis.
measureobject · required
Measure definition for key driver analysis.
referencePeriodstring · required
Reference period identifier.

KeyDriverAnalysisMeasure

idstring · required
Measure object identifier.
typestring · enum · required
Measure object type.
Enum values:
metric
fact
attribute

aggregation
Optional aggregation function.

KeyDriverAnalysisPart

kda
Optional full key driver analysis payload when available.
typestring · const
Type of multipart part.
Const value: kda
Default: kda

KeyDriversDimension

attributeobject · required
Object identifier.
attributeNamestring · required
labelobject · required
Object identifier.
labelNamestring · required

formatobject
Attribute format describes formatting information to effectively format attribute values when needed.
granularitystring · enum
Enum values:
SECOND
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR
HOUR_OF_DAY
valueTypestring · enum
Enum values:
TEXT
HYPERLINK
GEO
GEO_LONGITUDE
GEO_LATITUDE
GEO_AREA
GEO_ICON
IMAGE

KeyDriversRequest

metricobject · required
Metric is a quantity that is calculated from the data.

auxMetricsobject[]
Additional metrics to be included in the computation, but excluded from the analysis.
sortDirectionstring · enum
Sorting elements - ascending/descending order.
Enum values:
ASC
DESC
Default: DESC

KeyDriversResponse

dimensionsobject[] · required
linksobject · required
Links to the execution result.

KeyDriversResult

dataobject · required

KnowledgeSearchDetail

bestMatch
Title of the highest-scoring document. Null when nothing ranked.
categorystring · const
Category this body belongs to.
Const value: knowledgeSearch
Default: knowledgeSearch
documentsobject[]
Documents the action reached, best-scoring first.
query
What the action searched for. Null for an action that read a known document instead of searching.

KnowledgeSearchDocument

titlestring · required
Document title, falling back to its filename when it has none.

score
Relevance of the document's best-matching chunk. Null when the action did not rank it.

LabelIdentifier

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Label ID.
Example: label_id
typestring · enum · required
A type of the label.
Enum values:
label
Example: label

LdmObjectPermissions

rulesobject[] · required
List of rules
userGroupsobject[] · required
List of user groups
usersobject[] · required
List of users

LdmObjectPermissionsAssignment

permissionsstring[] · required
Enum values:
EDIT
SHARE
VIEW

LdmObjectPermissionsForAssignee

permissionsstring[] · required
Enum values:
EDIT
SHARE
VIEW
assigneeIdentifierobject · required
Identifier of a user or user-group.

LdmObjectPermissionsForAssigneeRule

permissionsstring[] · required
Enum values:
EDIT
SHARE
VIEW
assigneeRuleobject · required
Identifier of an assignee rule.

ListDocumentsResponse

documentsobject[] · required

nextPageToken
totalCount

ListLinks

selfstring · uri · required
A string containing the link's URL.

nextstring · uri
A string containing the link's URL for the next page of data.

ListLlmProviderModelsRequest

providerConfigrequired
Provider configuration overrides.

ListLlmProviderModelsResponse

messagestring · required
Message about the listing result.
modelsobject[] · required
Available models on the provider.
successboolean · required
Whether the model listing succeeded.

LiveFeatureFlagConfiguration

hoststring · required
keystring · required

LiveFeatures

contextobject · required
configurationobject · required

liveobject
Base Structure for feature flags

LlmModel

familystring · enum · required
Family of LLM models.
Enum values:
OPENAI
ANTHROPIC
META
MISTRAL
AMAZON
GOOGLE
COHERE
UNKNOWN
idstring · maxLength: 255 · required
Unique identifier of the model (e.g., gpt-5.3, claude-4.6).

LlmProviderConfig

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: auth, type
	type = object · requires: auth, region, type
	type = object · requires: auth, endpoint, type
	type = object · requires: auth, type

Properties for Variant 1:

Configuration for Anthropic provider.

authobject · required
Authentication configuration.
typestring · enum · required
Provider type.
Enum values:
ANTHROPIC

baseUrlstring · maxLength: 255
Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways.
Default: https://api.anthropic.com

LocalIdentifier

localIdentifierstring · required
Local identifier of the metric to be compared.
Example: m1

formatstring | null · maxLength: 2048
Metric format.
Example: #,##0
Default: #,##0.00
titlestring | null · maxLength: 255
Metric title.
Example: Revenue

LocaleRequest

localestring · required
Requested locale in the form of language tag (see RFC 5646).
Example: en-US

MatchAttributeFilter

matchAttributeFilterobject · required

MatchAttributeFilterBody

labelrequired
literalstring · required
matchTypestring · enum · required
Enum values:
STARTS_WITH
ENDS_WITH
CONTAINS

applyOnResult
caseSensitiveboolean
Default: false
localIdentifier
negateboolean
Default: false

MatchType

string · enum

Enum values:

STARTS_WITH

ENDS_WITH

CONTAINS

MatomoService

hoststring · required
Telemetry host to send events to.
siteIdinteger · int32 · required
Site ID on telemetry server.

reportingEndpointstring
Optional reporting endpoint for proxying telemetry events.

MeasureDefinition

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: inline
	type = object · requires: arithmeticMeasure
	type = object · requires: measure
	type = object

Properties for Variant 1:

Metric defined by the raw MAQL query.

inlineobject · required

MeasureExecutionResultHeader

measureHeaderobject · required
Header containing the information related to metrics.

MeasureGroupHeaders

measureGroupHeadersobject[]

MeasureHeader

localIdentifierstring · required
Local identifier of the measure this header relates to.

formatstring
Format to be used to format the measure data.
namestring
Name of the measure.

MeasureItem

definitionobject · required
Abstract metric definition type
localIdentifierstring · pattern: ^[.a-zA-Z0-9_-]+$ · required
Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
Example: metric_1

MeasureResultHeader

measureIndexinteger · int32 · required
Metric index. Starts at 0.
Example: 0

MeasureValueComparisonCondition

comparisonobject · required

MeasureValueCondition

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: comparison
	type = object · requires: range

Properties for ComparisonCondition:

Condition that compares the metric value to a given constant value using a comparison operator.

comparisonobject · required

MeasureValueFilter

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: comparisonMeasureValueFilter
	type = object · requires: rangeMeasureValueFilter
	type = object · requires: compoundMeasureValueFilter

Properties for ComparisonMeasureValueFilter:

Filter the result by comparing specified metric to given constant value, using given comparison operator.

comparisonMeasureValueFilterobject · required

MeasureValueRangeCondition

rangeobject · required

MemoryItemCreatedByUsers

reasoningstring · required
Reasoning for error states
usersobject[] · required
Users who created memory item

MemoryItemUser

firstnamestring · required
First name of the user who created memory item
lastnamestring · required
Last name of the user who created memory item
userIdstring · required
User ID of the user who created memory item

Metric

idstring · required
ID of the object
Example: revenue
titlestring · required
Title of metric.
typestring · enum · required
Object type
Enum values:
metric
fact
attribute
Example: metric

aggFunctionstring · enum
Agg function. Empty if a stored metric is used.
Enum values:
COUNT
SUM
MIN
MAX
AVG
MEDIAN

MetricDefinitionOverride

definitionobject · required
Metric defined by the raw MAQL query.
itemobject · required
Reference to the metric, fact or attribute object to use for the metric.

MetricOperand

localIdentifierstring · required
Local identifier of the metric to be compared.

format
Metric display format.
title
Metric display title.

MetricPermissions

rulesobject[] · required
List of rules
userGroupsobject[] · required
List of user groups
usersobject[] · required
List of users

MetricPermissionsAssignment

permissionsstring[] · required
Enum values:
EDIT
SHARE
VIEW

MetricPermissionsForAssignee

permissionsstring[] · required
Enum values:
EDIT
SHARE
VIEW
assigneeIdentifierobject · required
Identifier of a user or user-group.

MetricPermissionsForAssigneeRule

permissionsstring[] · required
Enum values:
EDIT
SHARE
VIEW
assigneeRuleobject · required
Identifier of an assignee rule.

MetricQueryDetail

categorystring · const
Category this body belongs to.
Const value: metricQuery
Default: metricQuery
filteredBystring[]
References of what the query filtered on. The conditions themselves are not carried.
groupedBystring[]
References of the attributes and date dimensions the query grouped by.
metricsstring[]
References of the metrics the query measured, as the query wrote them.
ref
Internal handle pairing the query that built a visualization with the execution that ran it. Group a category's items on it; never display it. Null on a query that was rejected, which has no partner to pair with.
resultColumns
Columns the execution returned.
resultRows
Rows the execution returned.
visualization
Title the query gave its visualization.

MetricRecord

valuenumber · double · required

formattedValuestring

MetricSortItem

directionstring · enum · required
Enum values:
ASC
DESC
metricsarray · required
typestring · const · required
Const value: metric_sort

MetricSortLocatorItem

bystring · required

elementstring
functionstring

MetricUsageResponse

currentValueinteger · required
previousValueinteger · required
typestring · enum · required
Metrics exposed by the AI observability endpoint.
Enum values:
AI_QUERIES
AI_WORKSPACES
AI_USERS

total

MetricValueChange

attributeNamestring · required
The name of the attribute being analyzed
attributeValuestring · required
The value of the attribute being analyzed
attributeValuesChangeMeannumber · double · required
The mean of attribute value changes for the attribute being analyzed
attributeValuesChangeStdnumber · double · required
The standard deviation of attribute value changes for the attribute being analyzed
isSignificantChangeboolean · required
Whether the change is statistically significant
metricValueDeltanumber · double · required
The delta between analyzed and reference periods
metricValueDeltaAbsnumber · double · required
The absolute delta between analyzed and reference periods
metricValueInAnalyzedPeriodnumber · double · required
The metric value in the analyzed period
metricValueInReferencePeriodnumber · double · required
The metric value in the reference period
overallMetricValueInAnalyzedPeriodnumber · double · required
The overall metric value in the analyzed period
overallMetricValueInReferencePeriodnumber · double · required
The overall metric value in the reference period

MetricValueComparisonFilter

conditionstring · enum · required
Enum values:
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
LESS_THAN
LESS_THAN_OR_EQUAL_TO
EQUAL_TO
NOT_EQUAL_TO
typestring · const · required
Const value: metric_value_filter
usingstring · required
valuerequired

null_values_as_zeroboolean

MetricValueFilterConditionComparison

string · enum

Enum values:

GREATER_THAN

GREATER_THAN_OR_EQUAL_TO

LESS_THAN

LESS_THAN_OR_EQUAL_TO

EQUAL_TO

NOT_EQUAL_TO

MetricValueFilterConditionRange

string · enum

Enum values:

BETWEEN

NOT_BETWEEN

MetricValueRangeFilter

conditionstring · enum · required
Enum values:
BETWEEN
NOT_BETWEEN
fromrequired
torequired
typestring · const · required
Const value: metric_value_filter
usingstring · required

null_values_as_zeroboolean

ModelTestResult

messagestring · required
Message about the model test result.
modelIdstring · required
The model ID that was tested.
successfulboolean · required
Whether the model test was successful.

MultipartContent

partsarray · required
Ordered multipart content fragments.

suggestions
Optional follow-up suggestions for the user. Populated only on the terminal user-visible multipart of a turn.
typestring · const
Type of item content.
Const value: multipart
Default: multipart

NegativeAttributeFilter

negativeAttributeFilterobject · required

NegativeAttributeFilterBody

labelrequired
notInobject · required
Filter on specific set of label values.

applyOnResult
localIdentifier
usesArbitraryValues

Note

appliesTostring · enum
Enum values:
SOURCE
TARGET
categorystring
contentstring
idstring
otherAttributesobject
priorityinteger · int32

Notes

noteobject[] · required

Notification

createdAtstring · date-time · required
datarequired
idstring · required
isReadboolean · required

automationIdstring
workspaceIdstring

NotificationChannelDestination

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: type
	type = object · requires: type
	type = object · requires: type
	type = object · requires: type

Properties for Variant 1:

Webhook destination for notifications. The property url is required on create and update.

typestring · enum · required
The destination type.
Enum values:
WEBHOOK

hasSecretKeyboolean | null · maxLength: 10000 · readOnly
Flag indicating if webhook has a hmac secret key.
hasTokenboolean | null · maxLength: 10000 · readOnly
Flag indicating if webhook has a token.
secretKeystring | null · maxLength: 10000 · writeOnly
Hmac secret key for the webhook signature.
Example: secret_key
tokenstring | null · maxLength: 10000 · writeOnly
Bearer token for the webhook.
Example: secret
urlstring · maxLength: 255 · pattern: (?=https?\://.*)(?=h…
The webhook URL.
Example: https://webhook.site/something

NotificationChannelRef

idstring · required
Notification channel identifier.

name
Notification channel display name.

NotificationContent

typestring · required

NotificationFilter

filterstring · required
titlestring · required

NotificationParameter

idstring · required
valuestring · required

titlestring

Notifications

dataobject[] · required
metaobject · required

NotificationsMeta

totalobject

NotificationsMetaTotal

allinteger · int64 · required
unreadinteger · int64 · required

NumberConstraints

maxnumber · double
minnumber · double

NumberParameterDefinition

defaultValuenumber · double · required
typestring · enum · required
The parameter type.
Enum values:
NUMBER

constraintsobject

ObjectConditionalFormatting

ObjectLinks

selfstring · uri · required
A string containing the link's URL.

ObjectLinksContainer

linksobject

ObjectReference

idstring · required
Object identifier (e.g. widget ID, metric ID).
typestring · enum · required
Type of the referenced object.
Enum values:
WIDGET
METRIC
ATTRIBUTE
DASHBOARD

ObjectReferenceGroup

objectsobject[] · required
Objects the user explicitly referenced within this context.

contextobject

ObjectStorageInfo

namestring · required
Human-readable name. Use this as sourceStorageName in CreatePipeTable, or pass storageId to ProvisionDatabase.storageIds.
Example: s3-data-lake
storageConfig