Sign in
Database table view groupings

Returns the existing view group by if the authorized user has access to the related database's workspace.

get/api/database/views/group_by/{view_group_by_id}/

Path parameters

view_group_by_idinteger required

Returns the view group by related to the provided value.

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.

Changes

No recorded changes to this endpoint across all 6 revisions of this API.