Cube Drilldown API
The Drilldown API from Cube — 1 operation(s) for drilldown.
The Drilldown API from Cube — 1 operation(s) for drilldown.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cubesoftware-drilldown-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Cube Drilldown API
version: 1.0.0 (1.0)
description: '#### General Description
An API to access underlying Cube functionality.'
termsOfService: https://www.cubesoftware.com/terms-of-service
servers:
- url: https://api.cubesoftware.com
description: Production API URL
tags:
- name: Drilldown
description: ''
paths:
/cube/drilldown:
get:
operationId: cube_drilldown_retrieve
description: '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.'
summary: Drilldown
parameters:
- in: query
name: Account
schema:
type: array
items:
type: string
description: A list of child Account dimensions
examples:
SingleAccountDimension:
value:
- Income Statement
summary: Single Account dimension
MultipleAccountDimensions:
value:
- Income Statement
- Revenue
- Product Revenue
summary: Multiple Account dimensions
- in: query
name: Department
schema:
type: array
items:
type: string
description: A list of child Department dimensions
examples:
SingleDepartmentDimension:
value:
- Sales and Marketing
summary: Single Department dimension
MultipleDepartmentDimensions:
value:
- Sales and Marketing
- Department - Other
summary: Multiple Department dimensions
- in: query
name: Scenario
schema:
type: array
items:
type: string
description: A list of child Scenario dimensions
examples:
SingleScenarioDimension:
value:
- Actuals
summary: Single Scenario dimension
MultipleScenarioDimensions:
value:
- Actuals
- Budget
- Forecast
summary: Multiple Scenario dimensions
- in: query
name: Time
schema:
type: array
items:
type: string
description: A list of child Time dimensions
examples:
SingleTimeDimension:
value:
- Q1-19
summary: Single Time dimension
MultipleTimeDimensions:
value:
- Jan-19
- Feb-19
summary: Multiple Time dimensions
- in: header
name: X-Company-ID
schema:
type: string
description: Associates request with company
required: true
- in: query
name: currency_code
schema:
type: string
description: The three character currency code
examples:
SampleValue:
value: USD
summary: Sample value
- in: query
name: export
schema:
type: string
enum:
- ''
- CSV
- XLSX
default: ''
description: Export type. Download link will be emailed when ready
examples:
NoExportExample:
value: null
summary: No Export Example
CSVExample:
value: CSV
summary: CSV Example
ExcelSpreadsheetExample:
value: XLSX
summary: Excel Spreadsheet Example
- in: query
name: full_path
schema:
type: boolean
default: false
description: Whether or not to include full dimension path in records of the response
examples:
SampleValue:
value: true
summary: Sample value
- in: query
name: include_zeroes
schema:
type: boolean
default: true
description: Whether or not to include records where value=0 in the response
examples:
SampleValue:
value: true
summary: Sample value
- in: query
name: limit
schema:
type: integer
description: The number of rows to limit the response to
examples:
SampleValue:
value: 10
summary: Sample value
- in: query
name: spreadsheet
schema:
type: boolean
default: false
description: Whether or not to return a 2D array for spreadsheet usage back (escapes Time dimension names)
examples:
SampleValue:
value: true
summary: Sample value
tags:
- Drilldown
security:
- OAuth2: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CubeDrilldownResponse'
description: ''
components:
schemas:
CubeDrilldownResponse:
type: object
properties:
id:
type: string
value:
type: string
formula:
type: object
additionalProperties: {}
calculated:
type: boolean
dimensions:
type: object
additionalProperties: {}
attributes:
type: object
additionalProperties: {}
splits:
type: array
items: {}
required:
- attributes
- calculated
- dimensions
- formula
- id
- splits
- value
securitySchemes:
OAuth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://portal.cubesoftware.com/o/authorize/
tokenUrl: https://api.cubesoftware.com/o/token/
scopes: {}
description: Standard Cube OAuth 2.0 flow