Reference
GraphQL API

GraphQL API reference

GraphQL API supports the following requests and parameters.

cube

query {
  cube [([cubeQueryArgs])] {
    <cubeName> [([cubeArgs])] {
      <cubeMember>
    }
  }
}
KeySchemaDescription
cubeQueryArgsCubeQueryArgsOptions that apply to the entire query
cubeArgsCubeArgsOptions that apply only to a specific cube

CubeQueryArgs

  • where (RootWhereInput): Represents a SQL WHERE clause.
  • limit (Int): A row limit for your query. The default value is 10000. The maximum allowed limit is 50000. If you'd like to request more rows than the maximum allowed limit, consider using pagination.
  • offset (Int): The number of initial rows to be skipped for your query. The default value is 0.
  • timezone (String): The timezone to use for the query. The default value is UTC.
  • renewQuery (Boolean): If renewQuery is set to true, Cube will renew all refreshKey for queries and query results in the foreground. The default value is false.
  • ungrouped (Boolean): If ungrouped is set to true, no GROUP BY statement will be added to the query. Instead, the raw results after filtering and joining will be returned without grouping. By default, ungrouped queries require a primary key as a dimension of every cube involved in the query for security purposes. For an ungrouped query, measures will be rendered without aggregation and time dimensions will be truncated as usual.

RootWhereInput

KeySchemaDescription
AND[RootWhereInput!]
OR[RootWhereInput!]
<cubeName>CubeWhereInput

CubeArgs

KeySchemaDescription
whereCubeWhereInput
orderByCubeOrderByInput

CubeWhereInput

KeySchemaDescription
AND[RootWhereInput!]
OR[RootWhereInput!]
<cubeMember>Filter

CubeOrderByInput

KeySchemaDescription
<cubeMember>OrderBy

Filter

DateTimeFilter | FloatFilter | StringFilter

DateTimeFilter

KeySchemaDescription
equalsString
notEqualsString
in[String]
notIn[String]
inDateRange[String]
notInDateRange[String]
beforeDateString
afterDateString
setBoolean

FloatFilter

KeySchemaDescription
equalsFloat
notEqualsFloat
in[Float]
notIn[Float]
setBoolean

StringFilter

KeySchemaDescription
equalsString
notEqualsString
in[String]
notIn[String]
containsString
notContainsString
setBoolean

OrderBy

asc | desc