GraphQL API reference

​

cube

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

​

Response extensions

• annotation — metadata for the query members (titles, types), the same as the annotation field of the REST API response.
• lastRefreshTime — an ISO 8601 timestamp indicating when the data was last refreshed.

​

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

​

CubeArgs

​

CubeWhereInput

​

CubeOrderByInput

​

Filter

​

DateTimeFilter

​

FloatFilter

​

StringFilter

​

OrderBy