Skip to content

cube.getFlows ​

Returns the data flows into and out of a cube. Flows are recorded when they happen, so a process only appears once it has actually read from or written to the cube.

js
cube.getFlows(cubeName)

Parameters ​

ParameterTypeDescription
cubeNamestringThe cube's name or id.

Returns ​

object | null

An object with two lists, or null when the cube can't be found:

  • destinations: the flows into the cube, such as processes that have written to it with cube.set or cube.increment.
  • sources: the flows out of the cube, such as processes that have read from it with cube.get.

Each flow has a source, a destination, a type (Process, Datasource or Formula) and last_modified, the time it was last used.

Examples ​

js
const flows = cube.getFlows("Sales");
json
{
    "destinations": [
        {
            "source": "Load Sales",
            "destination": "Sales",
            "type": "Process",
            "last_modified": "2026-10-20T23:16:15.272Z"
        }
    ],
    "sources": []
}
  • cube.sources: returns only the flows into a cube, as a JSON string.