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.
  • offset (Int): The number of initial rows to be skipped for your query. The default value is 0.
  • timezone (String): The time zone for your query. You can set the desired time zone in the TZ Database Name (opens in a new tab) format, e.g., America/Los_Angeles.
  • 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 set to true, Cube will run an ungrouped query.

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