Drilldown

Drilldown

This endpoint retrieves any values in the cube that make up the overall value at the provided cross section of dimensions. For instance, in the example JSON "Q1-19" was provided as the "Time" dimension and you can see that it returned a value for "Jan-19", "Feb-19", and "Mar-19" which all make up "Q1-19".

Drilling down into a cube value is very similar to viewing details for a value, and filtering in that you are able to pass either the names of the dimensions or their IDs as parameters. A dimension value must be provided for each top level dimension.

The drilldown endpoint supports other currencies as long as the company has the alternate currency enabled.

get/cube/drilldown

Query parameters

Accountstring[]

A list of child Account dimensions

Departmentstring[]

A list of child Department dimensions

Scenariostring[]

A list of child Scenario dimensions

Timestring[]

A list of child Time dimensions

currency_codestring

The three character currency code

export'' | 'CSV' | 'XLSX'

Export type. Download link will be emailed when ready

full_pathboolean

Whether or not to include full dimension path in records of the response

include_zeroesboolean

Whether or not to include records where value=0 in the response

limitinteger

The number of rows to limit the response to

spreadsheetboolean

Whether or not to return a 2D array for spreadsheet usage back (escapes Time dimension names)

Headers

X-Company-IDstring required

Associates request with company

Response

idstring required
valuestring required
formulaobject required
calculatedboolean required
dimensionsobject required
attributesobject required

Changes