GraphQL API reference

GraphQL API supports the following requests and parameters.

GraphQL API supports the following requests and parameters.

cube

query {
  cube [([cubeQueryArgs])] {
    <cubeName> [([cubeArgs])] {
      <cubeMember>
    }
  }
}

Key	Schema	Description
cubeQueryArgs	CubeQueryArgs	Options that apply to the entire query
cubeArgs	CubeArgs	Options 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 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

Key	Schema	Description
AND	[RootWhereInput!]
OR	[RootWhereInput!]
<cubeName>	CubeWhereInput

CubeArgs

Key	Schema	Description
where	CubeWhereInput
orderBy	CubeOrderByInput

CubeWhereInput

Key	Schema	Description
AND	[RootWhereInput!]
OR	[RootWhereInput!]
<cubeMember>	Filter

CubeOrderByInput

Key	Schema	Description
<cubeMember>	OrderBy

Filter

DateTimeFilter | FloatFilter | StringFilter

DateTimeFilter

Key	Schema	Description
equals	String
notEquals	String
in	[String]
notIn	[String]
inDateRange	[String]
notInDateRange	[String]
beforeDate	String
afterDate	String
set	Boolean

FloatFilter

Key	Schema	Description
equals	Float
notEquals	Float
in	[Float]
notIn	[Float]
set	Boolean

StringFilter

Key	Schema	Description
equals	String
notEquals	String
in	[String]
notIn	[String]
contains	String
notContains	String
set	Boolean

OrderBy

asc | desc