Download OpenAPI specification:Download
Create a new branch by doing an empty commit on a new branch without any data change. The new branch is a fork identical to the parent branch. The permissions can also be set on creation.
Branch to create.
| expectedEpoch | integer <int64> |
| name | string |
| parent | string |
object (JsonBranchPermissions) |
Success
{- "status": "ok"
}Fast-forward a branch to another one. The fast-forwarded branch is moved to the target head. It can only be done if the target has been forked from the branch and no new commit happened on the branch since. This requires owner permissions on the branch that is fast-forwarded and read permissions on the target.
| branch required | string Desired branch name. |
| fastForward required | string The name of the target branch where this branch will be fast forwarded. |
{- "status": "ok"
}Update the security of a branch. Permissions can be a user name, a role or the constant string ALL_USERS for all users. Requires to be owner of the branch.
| branch required | string Desired branch name. |
Permissions to set for the branch.
| owners | Array of strings unique |
| readers | Array of strings unique |
nullnullUpdate a database by removing, adding or updating facts in the specified branch.
| branch required | string Desired branch name. |
Update content in JSON format.
Array of objects (JsonDatabaseAction) | |
object (JsonDatabaseEditContext) | |
| expectedEpoch | integer <int64> |
nullnullExecute a query on the database, on a given table, via GET method. The query can be paginated using the parameters page and pageSize.
| tableName required | string Desired table name. |
| branch | string The branch on which to retrieve rows. Default is master branch. |
| epoch | integer <int64> Default: -1 The epoch on which to retrieve rows. Default is latest. |
| pageSize | integer <int32> Default: 20 The maximum number of rows in the page. Default is 100. |
| page | integer <int32> Default: 1 The page to return. First page (and default) is 1. |
| fields | Array of strings The fields (columns) of the rows to retrieve, separated by commas. If not specified, all the fields are returned. |
Success
Execute a query on the database, on a given table, via POST method. The query can be paginated using the parameters page and pageSize.
| tableName required | string Desired table name. |
| queryAction required | string Enum: "count" "select" Action flag to indicate a query on this table. |
| page | integer <int32> The page to return. First page (and default) is 1. |
| pageSize | integer <int32> The maximum number of rows in the page. Default is 100. |
| query | string Default: "ignored" |
Query parameters in JSON format.
| branch | string |
| conditions | object (JsonNode) |
| distinct | boolean |
| epoch | integer <int64> |
| fields | Array of strings |
| page | integer <int32> |
| pageSize | integer <int32> |
| timeout | integer <int64> |
Success
Success
Get the description of all the visible joins in the database.
{- "property1": {
- "property1": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}, - "property2": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}
}, - "property2": {
- "property1": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}, - "property2": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}
}
}Get the description of the given table name.
| tableName required | string Desired table name. |
{- "canDelete": true,
- "canEdit": true,
- "canInsert": true,
- "fields": [
- {
- "defaultValue": { },
- "hasParser": true,
- "index": 0,
- "name": "string",
- "readOnly": true,
- "type": "string"
}
], - "keyFields": [
- 0
]
}XML for Analysis (XMLA) endpoint for executing MDX queries and OLAP discovery operations.
This endpoint implements the XMLA protocol which is used by:
The endpoint supports both text XML and binary XML formats for improved performance.
Processes XMLA (XML for Analysis) requests for MDX query execution and OLAP metadata discovery.
This endpoint handles two types of XMLA operations:
The request body must be a valid XMLA SOAP envelope. The response format depends on content negotiation headers and can be returned as:
Session management is supported through XMLA session headers for maintaining context across multiple requests.
Executes the given MDX query and returns the result.
The MDX query to execute.
object | |
| mdx | string |
{- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string"
}Executes the given MDX query and returns only the query plan.
The MDX query for query plan inspection.
object | |
| mdx | string |
| queriesTimeLimit | string |
{- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string",
- "queriesTimeLimit": "string"
}Executes the given MDX SELECT query and returns only the query plan. Each query plan includes its underlying MDX pass. Pass naming convention: all passes except Sub-Select are named SelectPass_PassId.
| mdx required | string The query to run |
| timeout | integer <int32> The query timeout limit in seconds. |
| asSummary | string Default: "false" Whether ask for a summary or full query plan export. |
Executes the given MDX query and returns only the query plan.
The MDX query for query plan inspection.
object | |
| mdx | string |
| queriesTimeLimit | string |
{- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string",
- "queriesTimeLimit": "string"
}Returns a list of all currently running queries on the specified cube.
Availability: This endpoint is only available in version 10, revision 2 of the Pivot API. It is not available in version 9.
| cubeName required | string The name of the cube |
Terminates the execution of a specific query identified by its query ID on the specified cube.
The query must be running on the specified cube for the cancellation to succeed.
Experimental: This endpoint is experimental and may change in future releases.
| cubeName required | string The name of the cube |
| queryId required | integer <int64> The ID of the query to cancel |
Executes the given MDX query and returns the result.
The MDX query to execute.
object | |
| mdx | string |
{- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string"
}Executes the given MDX query and returns only the query plan.
The MDX query for query plan inspection.
object | |
| mdx | string |
| queriesTimeLimit | string |
{- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string",
- "queriesTimeLimit": "string"
}Executes the given MDX SELECT query and returns only the query plan. Each query plan includes its underlying MDX pass. Pass naming convention: all passes except Sub-Select are named SelectPass_PassId.
| mdx required | string The query to run |
| timeout | integer <int32> The query timeout limit in seconds. |
| asSummary | string Default: "false" Whether ask for a summary or full query plan export. |
Executes the given MDX query and returns only the query plan.
The MDX query for query plan inspection.
object | |
| mdx | string |
| queriesTimeLimit | string |
{- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string",
- "queriesTimeLimit": "string"
}If a path matches a directory, the directory all its sub-entries will also be deleted. If the last element of a path is a wildcard (*), all the entries within the parent directory will be deleted, leaving an empty directory.
| throwNotFoundParam required | string Default: "true" Enum: "false" "true" When set to False, the "Not Found" errors are silently ignored. |
| throwNotFound | string Default: "true" |
Serialized JSON parameter containing the entries to delete.
nullnullAllows atomic retrieval of the structure and, if needed, the content of the subtrees with roots and heights specified by path and recursion parameters of the entries, respectively. For each path the corresponding subtree height must be specified; if the height is less or equal to zero only the root itself is returned. For file entries the height should be less or equal to zero.
| throwNotFoundParam required | string Default: "true" Enum: "false" "true" When set to False, the "Not Found" errors are silently ignored. |
| includeContentParam required | string Default: "true" Enum: "false" "true" When set, the content of the retrieved files is included in the response. |
| throwNotFound | string Default: "true" |
| includeContent | string Default: "true" |
Serialized JSON parameter containing the entries to depth map.
| property name* additional property | integer <int32> |
nullnullFor each underlying move, if the target path refers to an existing directory, the entry is moved with its current name to the existing directory. Otherwise, the entry is renamed and moved to the target path. If intermediate directories are missing in the target paths, they will be created using the current user as the owner and reader.
| throwNotFoundParam required | string Default: "true" Enum: "false" "true" When set to False, the "Not Found" errors are silently ignored. |
| throwNotFound | string Default: "true" |
Serialized JSON parameter containing the entries to be moved in the form of source-to-target path mapping
nullnullThis method does not allow to create directories. The contents of all provided entries must be non null. Either all the entries or none of them are updated. The "throwNotFound" mode for this operation doesn't exist, because "Not Found" error is never encountered.
Serialized JSON parameter containing the entries to add or update specified by path to content map and access permissions.
| overwrite | boolean |
| owners | Array of strings |
object | |
| readers | Array of strings |
| recursive | boolean |
nullIf a path matches a directory, the directory all its sub-entries will also be deleted. If the last element of a path is a wildcard (*), all the entries within the parent directory will be deleted, leaving an empty directory.
| throwNotFoundParam required | string Default: "true" Enum: "false" "true" When set to False, the "Not Found" errors are silently ignored. |
| throwNotFound | string Default: "true" |
Serialized JSON parameter containing the entries to delete.
[- "string"
][- "string"
]Allows atomic retrieval of the structure and, if needed, the content of the subtrees with roots and heights specified by path and recursion parameters of the entries, respectively. For each path the corresponding subtree height must be specified; if the height is less or equal to zero only the root itself is returned. For file entries the height should be less or equal to zero.
| throwNotFoundParam required | string Default: "true" Enum: "false" "true" When set to False, the "Not Found" errors are silently ignored. |
| includeContentParam required | string Default: "true" Enum: "false" "true" When set, the content of the retrieved files is included in the response. |
| throwNotFound | string Default: "true" |
| includeContent | string Default: "true" |
Serialized JSON parameter containing the entries to depth map.
| property name* additional property | integer <int32> |
{- "property1": 0,
- "property2": 0
}{- "property1": {
- "children": {
- "property1": { },
- "property2": { }
}, - "entry": { }
}, - "property2": {
- "children": {
- "property1": { },
- "property2": { }
}, - "entry": { }
}
}For each underlying move, if the target path refers to an existing directory, the entry is moved with its current name to the existing directory. Otherwise, the entry is renamed and moved to the target path. If intermediate directories are missing in the target paths, they will be created using the current user as the owner and reader.
| throwNotFoundParam required | string Default: "true" Enum: "false" "true" When set to False, the "Not Found" errors are silently ignored. |
| throwNotFound | string Default: "true" |
Serialized JSON parameter containing the entries to be moved in the form of source-to-target path mapping
"string"[- "string"
]This method does not allow to create directories. The contents of all provided entries must be non null. Either all the entries or none of them are updated. The "throwNotFound" mode for this operation doesn't exist, because "Not Found" error is never encountered.
Serialized JSON parameter containing the entries to add or update specified by path to content map and access permissions.
| overwrite | boolean |
| owners | Array of strings |
object | |
| readers | Array of strings |
| recursive | boolean |
{- "overwrite": true,
- "owners": [
- "string"
], - "pathToContent": {
- "property1": "string",
- "property2": "string"
}, - "readers": [
- "string"
], - "recursive": true
}If the path is a directory all its sub-entries will also be deleted. If the last element of the path is a wildcard (*), all the entries within the parent directory will be deleted, leaving an empty directory.
| path required | string Default: "/" he path to apply the operation to. |
If the entry is a directory, lists all its accessible children recursively by default.
| path required | string Default: "/" he path to apply the operation to. |
| recursiveParam required | string Default: "-1" If the path is a directory, the maximum depth at which to retrieve children. -1 means that all available children are retrieved, 0 means that only the directory itself is retrieved. |
| includeContentParam required | string Default: "true" Enum: "false" "true" When set, the content of the retrieved file is included in the response. |
| recursive | string Default: "-1" |
| includeContent | string Default: "true" |
nullThe default operation creates a new entry under the current path with an auto-generated name.
| path required | string Default: "/" The path to apply the operation to. |
| moveCommand required | string Default: "ignored" Whether we should move the target entry. |
| importCommand required | string Default: "ignored" Whether this is an import command. The path is used as a prefix. |
| move | string Default: "ignored" |
| import | string Default: "ignored" |
The JSON parameters for the operation.
null{- "status": "ok"
}If the permissions parameter is set, only the permissions of the entry are updated.
| path required | string Default: "/" The path to apply the operation to. |
| permissionsParam required | string Default: "ignored" Whether only the permissions should be updated. |
| permissions | string Default: "ignored" |
The JSON parameters for the operation.
nullIf the path is a directory all its sub-entries will also be deleted. If the last element of the path is a wildcard (*), all the entries within the parent directory will be deleted, leaving an empty directory.
| path required | string Default: "/" he path to apply the operation to. |
If the entry is a directory, lists all its accessible children recursively by default.
| path required | string Default: "/" he path to apply the operation to. |
| recursiveParam required | string Default: "-1" If the path is a directory, the maximum depth at which to retrieve children. -1 means that all available children are retrieved, 0 means that only the directory itself is retrieved. |
| includeContentParam required | string Default: "true" Enum: "false" "true" When set, the content of the retrieved file is included in the response. |
| recursive | string Default: "-1" |
| includeContent | string Default: "true" |
nullThe default operation creates a new entry under the current path with an auto-generated name.
| path required | string Default: "/" The path to apply the operation to. |
| moveCommand required | string Default: "ignored" Whether we should move the target entry. |
| importCommand required | string Default: "ignored" Whether this is an import command. The path is used as a prefix. |
| move | string Default: "ignored" |
| import | string Default: "ignored" |
The JSON parameters for the operation.
null{- "status": "ok"
}If the permissions parameter is set, only the permissions of the entry are updated.
| path required | string Default: "/" The path to apply the operation to. |
| permissionsParam required | string Default: "ignored" Whether only the permissions should be updated. |
| permissions | string Default: "ignored" |
The JSON parameters for the operation.
nullCreate a new branch by doing an empty commit on a new branch without any data change. The new branch is a fork identical to the parent branch. The permissions can also be set on creation.
Branch to create.
| expectedEpoch | integer <int64> |
| name | string |
| parent | string |
object (JsonBranchPermissions) |
Success
{- "status": "ok"
}Fast-forward a branch to another one. The fast-forwarded branch is moved to the target head. It can only be done if the target has been forked from the branch and no new commit happened on the branch since. This requires owner permissions on the branch that is fast-forwarded and read permissions on the target.
| branch required | string Desired branch name. |
| fastForward required | string The name of the target branch where this branch will be fast forwarded. |
{- "status": "ok"
}Update the security of a branch. Permissions can be a user name, a role or the constant string ALL_USERS for all users. Requires to be owner of the branch.
| branch required | string Desired branch name. |
Permissions to set for the branch.
| owners | Array of strings unique |
| readers | Array of strings unique |
nullnullUpdate a database by removing, adding or updating facts in the specified branch.
| branch required | string Desired branch name. |
Update content in JSON format.
Array of objects (JsonDatabaseAction) | |
object (JsonDatabaseEditContext) | |
| expectedEpoch | integer <int64> |
nullnullExecute a query on the database, on a given table, via GET method. The query can be paginated using the parameters page and pageSize.
| tableName required | string Desired table name. |
| branch | string The branch on which to retrieve rows. Default is master branch. |
| epoch | integer <int64> Default: -1 The epoch on which to retrieve rows. Default is latest. |
| pageSize | integer <int32> Default: 20 The maximum number of rows in the page. Default is 100. |
| page | integer <int32> Default: 1 The page to return. First page (and default) is 1. |
| fields | Array of strings The fields (columns) of the rows to retrieve, separated by commas. If not specified, all the fields are returned. |
Success
Execute a query on the database, on a given table, via POST method. The query can be paginated using the parameters page and pageSize.
| tableName required | string Desired table name. |
| queryAction required | string Enum: "count" "select" Action flag to indicate a query on this table. |
| page | integer <int32> The page to return. First page (and default) is 1. |
| pageSize | integer <int32> The maximum number of rows in the page. Default is 100. |
| query | string Default: "ignored" |
Query parameters in JSON format.
| branch | string |
| conditions | object (JsonNode) |
| distinct | boolean |
| epoch | integer <int64> |
| fields | Array of strings |
| page | integer <int32> |
| pageSize | integer <int32> |
| timeout | integer <int64> |
Success
Success
Get the description of all the visible joins in the database.
{- "property1": {
- "property1": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}, - "property2": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}
}, - "property2": {
- "property1": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}, - "property2": {
- "fieldMappings": {
- "property1": "string",
- "property2": "string"
}, - "targetTable": "string"
}
}
}Get the description of the given table name.
| tableName required | string Desired table name. |
{- "canDelete": true,
- "canEdit": true,
- "canInsert": true,
- "fields": [
- {
- "defaultValue": { },
- "hasParser": true,
- "index": 0,
- "name": "string",
- "readOnly": true,
- "type": "string"
}
], - "keyFields": [
- 0
]
}Definition of the REST service returning the list of services exposed by an application.
Gets a listing of all APIs and their versions deployed by this application.
| includeRevision | boolean Default: false Include revision information in the response |
{- "apis": {
- "property1": {
- "versions": [
- {
- "id": "string",
- "includeRevision": { },
- "restPath": "string",
- "revision": 0,
- "wsPath": "string"
}
]
}, - "property2": {
- "versions": [
- {
- "id": "string",
- "includeRevision": { },
- "restPath": "string",
- "revision": 0,
- "wsPath": "string"
}
]
}
}, - "serverVersion": "string",
- "version": 0
}Retrieves a JSON Web Token (JWT) for the currently authenticated user.
If the user is already authenticated via JWT, the existing token is returned (to prevent token duration extension attacks). Otherwise, a new token is generated.
The returned token can be used for subsequent API requests by including it
in the Authorization header as: Authorization: Bearer <token>
{- "token": "string"
}Endpoints to retrieve and manage query history.
Note: This API is experimental and may change in future versions without notice.
Deletes all query history entries that match the specified filter criteria. If no filters are provided, all query history entries will be deleted. This operation also removes all associated metadata attributes for the deleted queries.
Filters can be combined to narrow down the selection of queries to delete. Queries that are still RUNNING cannot be deleted. If you need to delete running queries, you must cancel them first using the appropriate endpoint.
| user | any Example: user=jane.smith&user=john.doe Filter by username(s). Can be a single value or JSON array like ["user1", "user2"] |
| status | any Example: status=RUNNING&status=SUCCESSFUL Filter by query status(es). Can be a single value or JSON array |
| type | any Example: type=MDX&type=UNKNOWN Filter by query type(s). Can be a single value or JSON array |
| started_after | any Example: started_after=2025-01-01T10:00:00Z Only include queries started after this ISO-8601 date/time |
| started_before | any Example: started_before=2025-12-31T23:59:59Z Only include queries started before this ISO-8601 date/time |
| ended_after | any Example: ended_after=2025-01-01T10:00:00Z Only include queries ended after this ISO-8601 date/time |
| ended_before | any Example: ended_before=2025-12-31T23:59:59Z Only include queries ended before this ISO-8601 date/time |
| max_duration | any Example: max_duration=PT5M Maximum duration in milliseconds or ISO-8601 duration format (e.g., PT1H30M for 1 hour 30 minutes) |
| min_duration | any Example: min_duration=1000 Minimum duration in milliseconds or ISO-8601 duration format (e.g., PT1H30M for 1 hour 30 minutes) |
| metadata.* | any Example: metadata.*=metadata.foo=["abc1", "abc3"] Filter by metadata attributes using the pattern 'metadata.{attributeName}'. Can be a single value or JSON array. For example: metadata.foo=["value1", "value2"] |
required | object (MultiValueMapStringString) |
Retrieves a paginated list of query history entries based on the specified filter criteria. If no filters are provided, all query history entries will be returned.
The response includes query details along with associated metadata attributes for each entry, plus pagination metadata (total count, page number, page size, total pages). Filters can be combined to narrow down the selection of queries to retrieve.
Pagination is applied by default with a page size of 10 items. Use the 'page' and 'page_size' parameters to control pagination.
| page | any Page number (0-indexed). Default: 0 |
| page_size | any Example: page_size=10 Number of items per page. Default: 10 |
| user | any Example: user=jane.smith&user=john.doe Filter by username(s). Can be a single value or JSON array like ["user1", "user2"] |
| status | any Example: status=RUNNING&status=SUCCESSFUL Filter by query status(es). Can be a single value or JSON array. Valid values: RUNNING, SUCCESSFUL, FAILED, CANCELLED |
| type | any Example: type=MDX&type=UNKNOWN Filter by query type(s). Can be a single value or JSON array. Valid values: MDX, UNKNOWN |
| started_after | any Example: started_after=2025-01-01T10:00:00Z Only include queries started after this ISO-8601 date/time |
| started_before | any Example: started_before=2025-12-31T23:59:59Z Only include queries started before this ISO-8601 date/time |
| ended_after | any Example: ended_after=2025-01-01T10:00:00Z Only include queries ended after this ISO-8601 date/time |
| ended_before | any Example: ended_before=2025-12-31T23:59:59Z Only include queries ended before this ISO-8601 date/time |
| max_duration | any Example: max_duration=PT5M Maximum duration in milliseconds or ISO-8601 duration format (e.g., PT1H30M for 1 hour 30 minutes) |
| min_duration | any Example: min_duration=1000 Minimum duration in milliseconds or ISO-8601 duration format |
| metadata.* | any Example: metadata.*=metadata.foo=["abc1", "abc3"] Filter by metadata attributes using the pattern 'metadata.{attributeName}'. Can be a single value or JSON array. For example: metadata.foo=["value1", "value2"] |
required | object (MultiValueMapStringString) |
Cancels all currently running queries.
This operation will attempt to stop the execution of all queries with RUNNING status and update their status to CANCELLED. If some queries cannot be cancelled, the operation will continue with the remaining queries.
| status required | string Enum: "CANCELLED" "FAILED" "RUNNING" "SUCCESSFUL" Filter parameter that must be set to 'RUNNING' to target running queries. |
| status required | string Enum: "CANCELLED" "FAILED" "RUNNING" "SUCCESSFUL" |
{- "status": "CANCELLED"
}Deletes the query with the given ID from the query history.
Note that this will not cancel the query if it is still running. A running query must be cancelled first (PATCH endpoint) before it can be deleted.
| id required | string ID of the query within the query history. |
Cancels the running query with the given ID.
This operation will attempt to stop the query execution and update its status to CANCELLED. If the query is not currently running, the operation may fail.
| id required | string ID of the query to cancel. |
| status required | string Enum: "CANCELLED" "FAILED" "RUNNING" "SUCCESSFUL" |
{- "status": "CANCELLED"
}Retrieves the execution plan for a specific query by its unique identifier.
This endpoint re-executes the stored MDX query to generate the query plan data. The query must be of type MDX, otherwise a BadArgumentException will be thrown. An optional timeout can be specified to limit the execution time of the query plan generation.
Note: This operation requires an active cube setup and will re-execute the query.
| id required | string Example: 12345 Unique identifier of the query history entry |
| timeout | string Example: timeout=PT30S Optional timeout for query plan generation in ISO-8601 duration format (e.g., PT30S for 30 seconds) |
The statement itself defines on which ActivePivot instance it applies. There are various types of statements that are supported by the API. The full list and examples are provided by this documentation page.
MDX definition statement payload.
| owner | Array of strings |
| owners | Array of strings |
| reader | Array of strings |
| readers | Array of strings |
| statement | string |
{- "owner": [
- "string"
], - "owners": [
- "string"
], - "reader": [
- "string"
], - "readers": [
- "string"
], - "statement": "string"
}Some additional KPIs may be defined in the ActivePivot instance. However, if they cannot be edited through this API, they won't be listed by this call.
| pivotId required | string Name of the ActivePivot instance to query |
The statement itself defines on which ActivePivot instance it applies. There are various types of statements that are supported by the API. The full list and examples are provided by this documentation page.
MDX definition statement payload.
| owner | Array of strings |
| owners | Array of strings |
| reader | Array of strings |
| readers | Array of strings |
| statement | string |
{- "owner": [
- "string"
], - "owners": [
- "string"
], - "reader": [
- "string"
], - "readers": [
- "string"
], - "statement": "string"
}Some additional KPIs may be defined in the ActivePivot instance. However, if they cannot be edited through this API, they won't be listed by this call.
| pivotId required | string Name of the ActivePivot instance to query |
object (JsonMdxQuery) | |
object (IJsonOutputConfiguration) |
{- "jsonMdxQuery": {
- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string"
}, - "outputConfiguration": {
- "columnFormatters": [
- {
- "property1": "string",
- "property2": "string"
}
], - "fileConfiguration": {
- "directoryName": "string",
- "fileName": "string",
- "maxBatchesPerFile": 0,
- "maxLinesPerFile": 0,
- "useMultipleFiles": true,
- "useZipFile": true
}, - "format": "string"
}
}Exports the result of a MDX query in CSV or Arrow format to a file in the server or in the cloud.
Local Server Export: Files are exported to directories under the system temporary directory:
/tmp/<directoryName>C:\Users\<userName>\AppData\Local\Temp\<directoryName>The target directory must already exist before export. The export will fail if the directory does not exist.
Cloud Export:
Cloud exports are supported for configured cloud storage providers.
For cloud exports, the directoryName should specify the cloud path (e.g., S3 bucket path).
The MDX query to run and export options
object (JsonMdxQuery) | |
object (IJsonOutputConfiguration) |
{- "jsonMdxQuery": {
- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string"
}, - "outputConfiguration": {
- "columnFormatters": [
- {
- "property1": "string",
- "property2": "string"
}
], - "fileConfiguration": {
- "directoryName": "string",
- "fileName": "string",
- "maxBatchesPerFile": 0,
- "maxLinesPerFile": 0,
- "useMultipleFiles": true,
- "useZipFile": true
}, - "format": "string"
}
}{ }object (JsonMdxQuery) | |
object (IJsonOutputConfiguration) |
{- "jsonMdxQuery": {
- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string"
}, - "outputConfiguration": {
- "columnFormatters": [
- {
- "property1": "string",
- "property2": "string"
}
], - "fileConfiguration": {
- "directoryName": "string",
- "fileName": "string",
- "maxBatchesPerFile": 0,
- "maxLinesPerFile": 0,
- "useMultipleFiles": true,
- "useZipFile": true
}, - "format": "string"
}
}Exports the result of a MDX query in CSV or Arrow format to a file in the server or in the cloud.
Local Server Export: Files are exported to directories under the system temporary directory:
/tmp/<directoryName>C:\Users\<userName>\AppData\Local\Temp\<directoryName>The target directory must already exist before export. The export will fail if the directory does not exist.
Cloud Export:
Cloud exports are supported for configured cloud storage providers.
For cloud exports, the directoryName should specify the cloud path (e.g., S3 bucket path).
The MDX query to run and export options
object (JsonMdxQuery) | |
object (IJsonOutputConfiguration) |
{- "jsonMdxQuery": {
- "context": {
- "property1": "string",
- "property2": "string"
}, - "mdx": "string"
}, - "outputConfiguration": {
- "columnFormatters": [
- {
- "property1": "string",
- "property2": "string"
}
], - "fileConfiguration": {
- "directoryName": "string",
- "fileName": "string",
- "maxBatchesPerFile": 0,
- "maxLinesPerFile": 0,
- "useMultipleFiles": true,
- "useZipFile": true
}, - "format": "string"
}
}{ }Computes the partial aggregate providers needed to efficiently cover the query history. Partial aggregate providers are recommended for every data cube. This operation is intended to be called in a test environment, in order not to impact the production environment.
| coverTarget required | number <double> Fraction of query history to cover |
GetAggregatesQuery (GAQ) REST API for executing OLAP queries.
This API provides a programmatic way to execute GetAggregatesQuery operations against Atoti cubes. Results are returned in Apache Arrow format for efficient data transfer and processing.
Note: This API is experimental and may change in future versions without notice.
Executes a GAQ query on the specified cube and branch, with given measures, coordinates, filters, context, and timeout. The result is returned as an Apache Arrow stream.
| branch | string The specific branch of the cube to query. By default, the branch set by activeviam.branch.master property. |
object Additional context values to configure query execution. Supported context values include:
Context values are applied during query execution and reset after the query completes. | |
object The coordinates for the query, mapping level descriptions to level members. | |
| cubeName required | string The name of the cube to query. |
object (Filter) Filter conditions to apply to the query. | |
| measures required | Array of strings The list of measures to include in the query. |
| timeout | integer <int32> The timeout for the query in seconds. |
{- "branch": "string",
- "context": {
- "property1": "string",
- "property2": "string"
}, - "coordinates": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "cubeName": "string",
- "filter": {
- "isInConditions": {
- "values": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "notInConditions": {
- "values": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
}, - "measures": [
- "string"
], - "timeout": 0
}