Skip to main content
POST
/
activeviam
/
pivot
/
rest
/
v10
/
cube
/
query
/
gaq
Executes a GAQ and returns the result as an Arrow stream.
curl --request POST \
  --url http://localhost:9090/activeviam/pivot/rest/v10/cube/query/gaq \
  --header 'Content-Type: application/json' \
  --data '
{
  "cubeName": "<string>",
  "measures": [
    "<string>"
  ],
  "branch": "<string>",
  "context": {},
  "coordinates": {},
  "filter": {
    "isInConditions": {
      "values": {}
    },
    "notInConditions": {
      "values": {}
    }
  },
  "timeout": 123
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
cubeName
string
required

The name of the cube to query.

​
measures
string[]
required

The list of measures to include in the query.

​
branch
string

The specific branch of the cube to query. By default, the branch set by activeviam.branch.master property.

​
context
object

Additional context values to configure query execution. Supported context values include:

  • queriesTimeLimit: Query timeout in seconds (e.g., "30")
  • queriesResultLimit: Maximum number of cells to return (e.g., "10000")

Context values are applied during query execution and reset after the query completes.

​
coordinates
object

The coordinates for the query, mapping level descriptions to level members. Use null or the wildcard string as the value to express a wildcard (all members) for a given level. The wildcard string defaults to [*] and can be configured via the activepivot.location.wildcard system property. For example: {"Currency@Currency@Currency": ["[*]"]}.

​
filter
object

Filter conditions to apply to the query.

​
timeout
integer<int32>

The timeout for the query in seconds.

Response

200 - application/vnd.apache.arrow.stream

Successful execution of the GAQ.