Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Database table view groupings

Creates a new group by for the view related to the provided view_id parameter if the authorized user has access to the related database's workspace.

post/api/database/views/{view_id}/group_bys/

Path parameters

view_idinteger required

Creates a group by for the view related to the provided value.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

ClientUndoRedoActionGroupIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.

Request body

fieldinteger required

The field that must be grouped by.

order'ASC' | 'DESC'
  • ASC - Ascending
  • DESC - Descending
widthinteger

The pixel width of the group by in the related view.

typestring

Indicates the sort type. Will automatically fall back to default if incompatible with field type.

Response

idinteger required
viewinteger required

The view to which the group by applies. Each view can have his own group bys.

fieldinteger required

The field that must be grouped by.

order'ASC' | 'DESC'
  • ASC - Ascending
  • DESC - Descending
widthinteger

The pixel width of the group by in the related view.

typestring

Indicates the sort type. Will automatically fall back to default if incompatible with field type.

priorityinteger required

Position of this group by in the ordering chain. The group by with the lowest priority is applied first.