views

listViews

List view definitions for a project (latest snapshot per view name)

GET

Usage:

const result = await swirls.client.views.listViews({
  projectId: '...',
})

Input:

Parameter	Type	Required	Description
`projectId`	`string`	Yes

Column layout for a view (mapped JSON Schema properties, source fields, computed columns)

GET

Usage:

const result = await swirls.client.views.schema({
  projectId: '...',
  viewName: '...',
})

Input:

Parameter	Type	Required
`projectId`	`string`	Yes
`appName`	`string`	No
`viewName`	`string`	Yes

Output:

Field	Type	Description
`name`	`string`
`columns`	`object[]`

Page materialized rows for a view, joined with computed cell values and statuses

GET

Usage:

const result = await swirls.client.views.queryViewRows({
  projectId: '...',
  viewName: '...',
  limit: 1,
})

Input:

Parameter	Type	Required
`projectId`	`string`	Yes
`appName`	`string`	No
`viewName`	`string`	Yes
`cursor`	`string`	No
`limit`	`number`	Yes
`offset`	`number`	No
`filters`	`object[]`	No
`search`	`string`	No
`orderBy`	`object`	No

Output:

Start a backfill that materializes existing stream rows for a view and runs its computed columns

POST

Usage:

const result = await swirls.client.views.recomputeView({
  projectId: '...',
  viewName: '...',
})

Input:

Parameter	Type	Required
`projectId`	`string`	Yes
`appName`	`string`	No
`viewName`	`string`	Yes