ViewResponse

Data returned for View. Required fields are id, name, category, tables, schema, item.

idId (string)required

Server-assigned unique identifier

nameName (string)required

Resource name

alias object

URL-safe short handle

anyOf

• string
• null

string

categoryCategory (string)required

Resource type tag

typeType (string)

Allowed values: view, materialized.

Possible values: [view, materialized]

Default value: view

collection_id object

Parent collection ID

anyOf

• string
• null

string

folder_id object

Identifier of the containing folder.

anyOf

• string
• null

string

tags object

Classification labels

anyOf

• string[]
• null

Array [

string

]

description object

Resource description

anyOf

• string
• null

string

markingsstring[]

Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

Default value: []

created_at object

Creation timestamp (Unix ms)

anyOf

• integer
• null

integer

updated_at object

Last update timestamp (Unix ms)

anyOf

• integer
• null

integer

owners object[]

Users and groups that own the resource.

Array [

idId (string)required

"user." | "group." | "public.all"

typeType (string)required

Possible values: [user, group, public]

display_nameDisplay Name (string)required

avatar_url object

anyOf

• string
• null

string

avatar_config object

anyOf

• object
• null

object

email object

anyOf

• string<email>
• null

string<email>

]

my_share_scope object

How the current caller received access to the resource.

anyOf

• string
• null

string

Possible values: [owner, grant, admin]

tables object[]required

Backing resources. tables[0] is the primary FROM clause; non-primary entries are introduced by a matching ViewJoin.

Array [

aliasAlias (string)required

SQL alias used in column references

typeType (string)required

Backing resource category

Possible values: [dataset, source]

resourceResource (string)required

Identifier of the dataset or source used by this view table.

]

joins object

Joins between tables (length = len(tables) - 1 when set)

anyOf

• object[]
• null

Array [

targetTarget (string)required

alias of the ViewTable this join introduces

kindJoinKind (string)

Allowed Join Kind values. Values: inner, left, right, full.

Possible values: [inner, left, right, full]

Default value: inner

on object[]required

AND'd binary conditions

Array [

left objectrequired

Join condition operand. Exactly one of column / expression set.

column object

Backing column reference in 'alias.col' form

anyOf

• string
• null

string

expression object

SQL fragment when the operand is a computed expression

anyOf

• string
• null

string

right objectrequired

Join condition operand. Exactly one of column / expression set.

column object

Backing column reference in 'alias.col' form

anyOf

• string
• null

string

expression object

SQL fragment when the operand is a computed expression

anyOf

• string
• null

string

operatorJoinOperator (string)

Allowed Join Operator values. Values: eq, ne, gt, gte, lt, lte.

Possible values: [eq, ne, gt, gte, lt, lte]

Default value: eq

]

]

schema objectrequired

Output Arrow schema. field names define the projection — columns not present here are dropped from the view output.

property name*any

Output Arrow schema. field names define the projection — columns not present here are dropped from the view output.

column_masks object

Derivation rule per output column (key = schema_ field name). Missing entries default to passthrough on the same-named primary backing column.

anyOf

• object
• null

object

row_filters object

WHERE clause applied on the backing tables

anyOf

• RowFilter
• null

kindKind (string)

Possible values: [and, or]

Default value: and

conditions object[]

Nested conditions (leaf RowFilterCondition or group RowFilter)

Array [

anyOf

• RowFilterCondition
• Option 2

kindKind (string)

Constant value: condition

Default value: condition

columnColumn (string)required

Column name to filter on

operatorRowFilterOperator (string)required

Allowed Row Filter Operator values. Values: eq, ne, gt, gte, lt, lte, in, not_in, and 4 more.

Possible values: [eq, ne, gt, gte, lt, lte, in, not_in, between, like, is_null, is_not_null]

value object

Filter value. Single value for scalar operators, list for 'in'/'not_in', 2-element list for 'between'. Omit for 'is_null'/'is_not_null'.

anyOf

• Option 1
• null

]

group_by object

GROUP BY keys (subset of schema_ field names)

anyOf

• string[]
• null

Array [

string

]

having object

HAVING clause (requires group_by)

anyOf

• RowFilter
• null

kindKind (string)

Possible values: [and, or]

Default value: and

conditions object[]

Nested conditions (leaf RowFilterCondition or group RowFilter)

Array [

anyOf

• RowFilterCondition
• Option 2

kindKind (string)

Constant value: condition

Default value: condition

columnColumn (string)required

Column name to filter on

operatorRowFilterOperator (string)required

Allowed Row Filter Operator values. Values: eq, ne, gt, gte, lt, lte, in, not_in, and 4 more.

Possible values: [eq, ne, gt, gte, lt, lte, in, not_in, between, like, is_null, is_not_null]

value object

Filter value. Single value for scalar operators, list for 'in'/'not_in', 2-element list for 'between'. Omit for 'is_null'/'is_not_null'.

anyOf

• Option 1
• null

]

itemItem (string)requireddeprecated

ViewResponse

{
  "id": "string",
  "name": "string",
  "alias": "string",
  "category": "string",
  "type": "view",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "markings": [
    "string"
  ],
  "created_at": 0,
  "updated_at": 0,
  "owners": [
    {
      "id": "string",
      "type": "user",
      "display_name": "string",
      "avatar_url": "string",
      "avatar_config": {},
      "email": "user@example.com"
    }
  ],
  "my_share_scope": "owner",
  "tables": [
    {
      "alias": "string",
      "type": "dataset",
      "resource": "string"
    }
  ],
  "joins": [
    {
      "target": "string",
      "kind": "inner",
      "on": [
        {
          "left": {
            "column": "string",
            "expression": "string"
          },
          "right": {
            "column": "string",
            "expression": "string"
          },
          "operator": "eq"
        }
      ]
    }
  ],
  "schema": {},
  "column_masks": {},
  "row_filters": {
    "kind": "and",
    "conditions": [
      {
        "kind": "condition",
        "column": "string",
        "operator": "eq"
      },
      null
    ]
  },
  "group_by": [
    "string"
  ],
  "having": {
    "kind": "and",
    "conditions": [
      {
        "kind": "condition",
        "column": "string",
        "operator": "eq"
      },
      null
    ]
  }
}