OpenAPI definition

Computation (3.51)

Endpoint:/

(EXPERIMENTAL) Compute column statistics

POST

/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics

(EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source.

(EXPERIMENTAL) Compute column statistics › path Parameters

dataSourceIdstring · required

(EXPERIMENTAL) Compute column statistics › Request Body

columnNamestring · required
fromrequired

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

(EXPERIMENTAL) Compute column statistics › Responses

frequencyobject
histogramobject
statisticsobject[]
warningsobject[]

(BETA) Valid descendants

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants

(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.

(BETA) Valid descendants › path Parameters

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

(BETA) Valid descendants › Request Body

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

(BETA) Valid descendants › Responses

Map of lists of attributes valid as descendants of the given attributes.

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

Valid objects

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects

Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.

Valid objects › path Parameters

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

Valid objects › Request Body

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

Valid objects › Responses

List of attributes, facts and metrics valid with respect to given AFM.

itemsobject[] · required

Executes analytical request and returns link to the result

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute

AFM is a combination of attributes, measures and filters that describe a query you want to execute.

Executes analytical request and returns link to the result › path Parameters

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

Executes analytical request and returns link to the result › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false
timestampstring · timestamp
Timestamp for the execution. Deprecated, use settings.timestamp in the request body.

Executes analytical request and returns link to the result › Request Body

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

Executes analytical request and returns link to the result › Responses

AFM Execution response with links to the result and server-enhanced dimensions from the original request.

executionResponseobject · required
Response to AFM execution request body

Get a single execution result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}

Gets a single execution result.

Get a single execution result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

Get a single execution result › query Parameters

offsetinteger[] · style: form
Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.
Default: []
limitinteger[] · style: form
Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.
Default: []
excludedTotalDimensionsstring[] · style: form
Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.
Default: []

Get a single execution result › Headers

X-GDC-CANCEL-TOKENstring

Get a single execution result › Responses

Execution result was found and returned.

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.

Get a single execution result's metadata.

GET

/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata

The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse

Get a single execution result's metadata. › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

Get a single execution result's metadata. › Responses

Execution result's metadata was found and returned.

afmobject · required
Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
executionResponseobject · required
Response to AFM execution request body
resultSizeinteger · int64 · required
resultSpecobject · required
Specifies how the result data will be formatted (dimensions) and which additional data shall be computed (totals).

AFM explain resource.

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain

The resource provides static structures needed for investigation of a problem with given AFM.

AFM explain resource. › path Parameters

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

AFM explain resource. › query Parameters

explainTypestring · enum
Requested explain type. If not specified all types are bundled in a ZIP archive.

MAQL - MAQL Abstract Syntax Tree, execution dimensions and related info

GRPC_MODEL - Datasets used in execution

GRPC_MODEL_SVG - Generated SVG image of the datasets

COMPRESSED_GRPC_MODEL_SVG - Generated SVG image of the model fragment used in the query

WDF - Workspace data filters in execution workspace context

QT - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL

QT_SVG - Generated SVG image of the Query Tree

OPT_QT - Optimized Query Tree

OPT_QT_SVG - Generated SVG image of the Optimized Query Tree

SQL - Final SQL to be executed

COMPRESSED_SQL - Final SQL to be executed with rolled SQL datasets

SETTINGS - Settings used to execute explain request
Enum values:
MAQL
GRPC_MODEL
GRPC_MODEL_SVG
WDF
QT
QT_SVG
OPT_QT
OPT_QT_SVG

AFM explain resource. › Request Body

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

AFM explain resource. › Responses

Requested resource

No data returned

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.

POST

/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements

Returns paged list of elements (values) of given label satisfying given filtering criteria.

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › path Parameters

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

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › query Parameters

offsetinteger · int32 · min: 0 · max: 10000
Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.
Default: 0
limitinteger · int32 · min: 1 · max: 10000
Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.
Default: 1000

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › Request Body

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

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › Responses

List of label values.

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:
MINUTE
HOUR
DAY
WEEK
MONTH
QUARTER
YEAR
MINUTE_OF_HOUR

Compute change analysis

POST

/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis

Computes change analysis for the provided execution definition.

Compute change analysis › path Parameters

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

Compute change analysis › Request Body

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
filtersarray
Optional filters to apply.
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

Compute change analysis › Responses

linksobject · required
Links to the execution result.

Get change analysis result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}

Gets change analysis result.

Get change analysis result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

Get change analysis result › Responses

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

(EXPERIMENTAL) Compute key driver analysis

POST

/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers

(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.

(EXPERIMENTAL) Compute key driver analysis › path Parameters

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

(EXPERIMENTAL) Compute key driver analysis › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false

(EXPERIMENTAL) Compute key driver analysis › Request Body

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

(EXPERIMENTAL) Compute key driver analysis › Responses

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

(EXPERIMENTAL) Get key driver analysis result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}

(EXPERIMENTAL) Gets key driver analysis.

(EXPERIMENTAL) Get key driver analysis result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

(EXPERIMENTAL) Get key driver analysis result › query Parameters

offsetinteger · int32
limitinteger · int32

(EXPERIMENTAL) Get key driver analysis result › Responses

dataobject · required

(BETA) Outlier Detection

POST

/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers

(BETA) Computes outlier detection for the provided execution definition.

(BETA) Outlier Detection › path Parameters

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

(BETA) Outlier Detection › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false

(BETA) Outlier Detection › Request Body

attributesobject[] · required
Attributes to be used in the computation.
filtersarray · required
Various filter types to filter the execution result.
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
measuresobject[] · minItems: 1 · required
sensitivitystring · enum · required
Sensitivity level for outlier detection
Enum values:
LOW
MEDIUM
HIGH

auxMeasuresobject[]
Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.

(BETA) Outlier Detection › Responses

linksobject · required
Links to the execution result.

(BETA) Outlier Detection Result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}

(BETA) Gets outlier detection result.

(BETA) Outlier Detection Result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

(BETA) Outlier Detection Result › query Parameters

offsetinteger · int32
limitinteger · int32

(BETA) Outlier Detection Result › Responses

attributearray | null · required
Attribute values for outlier detection results.
valuesobject | null · required
Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.

Usage Smart Functions

OpenAPI definition

Computation (3.51)

Endpoint:/

(EXPERIMENTAL) Compute column statistics

POST

/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics

(EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source.

(EXPERIMENTAL) Compute column statistics › path Parameters

dataSourceIdstring · required

(EXPERIMENTAL) Compute column statistics › Request Body

columnNamestring · required
fromrequired

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

(EXPERIMENTAL) Compute column statistics › Responses

frequencyobject
histogramobject
statisticsobject[]
warningsobject[]

(BETA) Valid descendants

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants

(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.

(BETA) Valid descendants › path Parameters

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

(BETA) Valid descendants › Request Body

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

(BETA) Valid descendants › Responses

Map of lists of attributes valid as descendants of the given attributes.

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

Valid objects

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects

Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.

Valid objects › path Parameters

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

Valid objects › Request Body

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

Valid objects › Responses

List of attributes, facts and metrics valid with respect to given AFM.

itemsobject[] · required

Executes analytical request and returns link to the result

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute

AFM is a combination of attributes, measures and filters that describe a query you want to execute.

Executes analytical request and returns link to the result › path Parameters

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

Executes analytical request and returns link to the result › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false
timestampstring · timestamp
Timestamp for the execution. Deprecated, use settings.timestamp in the request body.

Executes analytical request and returns link to the result › Request Body

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

Executes analytical request and returns link to the result › Responses

AFM Execution response with links to the result and server-enhanced dimensions from the original request.

executionResponseobject · required
Response to AFM execution request body

Get a single execution result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}

Gets a single execution result.

Get a single execution result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

Get a single execution result › query Parameters

offsetinteger[] · style: form
Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.
Default: []
limitinteger[] · style: form
Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.
Default: []
excludedTotalDimensionsstring[] · style: form
Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.
Default: []

Get a single execution result › Headers

X-GDC-CANCEL-TOKENstring

Get a single execution result › Responses

Execution result was found and returned.

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.

Get a single execution result's metadata.

GET

/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata

The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse

Get a single execution result's metadata. › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

Get a single execution result's metadata. › Responses

Execution result's metadata was found and returned.

afmobject · required
Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
executionResponseobject · required
Response to AFM execution request body
resultSizeinteger · int64 · required
resultSpecobject · required
Specifies how the result data will be formatted (dimensions) and which additional data shall be computed (totals).

AFM explain resource.

POST

/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain

The resource provides static structures needed for investigation of a problem with given AFM.

AFM explain resource. › path Parameters

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

AFM explain resource. › query Parameters

explainTypestring · enum
Requested explain type. If not specified all types are bundled in a ZIP archive.

MAQL - MAQL Abstract Syntax Tree, execution dimensions and related info

GRPC_MODEL - Datasets used in execution

GRPC_MODEL_SVG - Generated SVG image of the datasets

COMPRESSED_GRPC_MODEL_SVG - Generated SVG image of the model fragment used in the query

WDF - Workspace data filters in execution workspace context

QT - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL

QT_SVG - Generated SVG image of the Query Tree

OPT_QT - Optimized Query Tree

OPT_QT_SVG - Generated SVG image of the Optimized Query Tree

SQL - Final SQL to be executed

COMPRESSED_SQL - Final SQL to be executed with rolled SQL datasets

SETTINGS - Settings used to execute explain request
Enum values:
MAQL
GRPC_MODEL
GRPC_MODEL_SVG
WDF
QT
QT_SVG
OPT_QT
OPT_QT_SVG

AFM explain resource. › Request Body

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

AFM explain resource. › Responses

Requested resource

No data returned

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.

POST

/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements

Returns paged list of elements (values) of given label satisfying given filtering criteria.

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › path Parameters

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

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › query Parameters

offsetinteger · int32 · min: 0 · max: 10000
Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.
Default: 0
limitinteger · int32 · min: 1 · max: 10000
Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.
Default: 1000

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › Request Body

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

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows. › Responses

List of label values.

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:
MINUTE
HOUR
DAY
WEEK
MONTH
QUARTER
YEAR
MINUTE_OF_HOUR

Compute change analysis

POST

/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis

Computes change analysis for the provided execution definition.

Compute change analysis › path Parameters

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

Compute change analysis › Request Body

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
filtersarray
Optional filters to apply.
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

Compute change analysis › Responses

linksobject · required
Links to the execution result.

Get change analysis result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}

Gets change analysis result.

Get change analysis result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

Get change analysis result › Responses

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

(EXPERIMENTAL) Compute key driver analysis

POST

/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers

(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.

(EXPERIMENTAL) Compute key driver analysis › path Parameters

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

(EXPERIMENTAL) Compute key driver analysis › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false

(EXPERIMENTAL) Compute key driver analysis › Request Body

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

(EXPERIMENTAL) Compute key driver analysis › Responses

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

(EXPERIMENTAL) Get key driver analysis result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}

(EXPERIMENTAL) Gets key driver analysis.

(EXPERIMENTAL) Get key driver analysis result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

(EXPERIMENTAL) Get key driver analysis result › query Parameters

offsetinteger · int32
limitinteger · int32

(EXPERIMENTAL) Get key driver analysis result › Responses

dataobject · required

(BETA) Outlier Detection

POST

/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers

(BETA) Computes outlier detection for the provided execution definition.

(BETA) Outlier Detection › path Parameters

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

(BETA) Outlier Detection › Headers

skip-cacheboolean
Ignore all caches during execution of current request.
Default: false

(BETA) Outlier Detection › Request Body

attributesobject[] · required
Attributes to be used in the computation.
filtersarray · required
Various filter types to filter the execution result.
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
measuresobject[] · minItems: 1 · required
sensitivitystring · enum · required
Sensitivity level for outlier detection
Enum values:
LOW
MEDIUM
HIGH

auxMeasuresobject[]
Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.

(BETA) Outlier Detection › Responses

linksobject · required
Links to the execution result.

(BETA) Outlier Detection Result

GET

/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}

(BETA) Gets outlier detection result.

(BETA) Outlier Detection Result › path Parameters

workspaceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
Workspace identifier
resultIdstring · required
Result ID

(BETA) Outlier Detection Result › query Parameters

offsetinteger · int32
limitinteger · int32

(BETA) Outlier Detection Result › Responses

attributearray | null · required
Attribute values for outlier detection results.
valuesobject | null · required
Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.

Usage Smart Functions