curl '{backend_url}/admin/views/{entity}/columns' \
-H 'Authorization: Bearer {jwt_token}'{
"columns": [
{
"id": "<string>",
"name": "<string>",
"field": "<string>",
"sortable": true,
"hideable": true,
"default_visible": true,
"data_type": "string",
"description": "<string>",
"semantic_type": "<string>",
"context": "<string>",
"computed": {
"type": "<string>",
"required_fields": [
"<string>"
],
"optional_fields": [
"<string>"
]
},
"relationship": {
"entity": "<string>",
"field": "<string>"
},
"default_order": 123,
"category": "status"
}
]
}List Columns in View
Retrieve a list of columns in a view for an entity. The columns are retrieved for the authenticated admin user.
curl '{backend_url}/admin/views/{entity}/columns' \
-H 'Authorization: Bearer {jwt_token}'{
"columns": [
{
"id": "<string>",
"name": "<string>",
"field": "<string>",
"sortable": true,
"hideable": true,
"default_visible": true,
"data_type": "string",
"description": "<string>",
"semantic_type": "<string>",
"context": "<string>",
"computed": {
"type": "<string>",
"required_fields": [
"<string>"
],
"optional_fields": [
"<string>"
]
},
"relationship": {
"entity": "<string>",
"field": "<string>"
},
"default_order": 123,
"category": "status"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The entity to retrieve its columns (for example, orders)
Response
OK
The view's columns.
The view's columns.
Show child attributes
Show child attributes
The column's ID.
The column's name. This is displayed in the view header.
The column's field in the entity.
Whether the column is sortable.
Whether the column is hideable.
Whether the column is visible by default.
The data type of the column's value.
string, number, boolean, object, date, currency, enum The column's description.
The column's semantic type. It can be computed, or other primitive types.
The column's context. It can be display or generic.
A computed column's details. Only available if the column's semantic_type is computed.
Show child attributes
Show child attributes
The computed's type for rendering.
The required fields in the computed column.
A required field in the computed column.
The optional fields in the computed column.
An optional field in the computed column.
The column's sort order in the default view configuration.
The column's category.
status, metadata, identifier, timestamp, metric, relationship