List columns for all elements in a data model

GET

/v2/dataModels/:dataModelId/columns

GET

/v2/dataModels/:dataModelId/columns

$ curl https://api.sigmacomputing.com/v2/dataModels/dataModelId/columns \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "columnId": "col_9f8b7a6d",
5       "name": "Total Sales",
6       "formula": "SUM(Sales.Amount)",
7       "type": {
8         "format": "decimal",
9         "precision": 10,
10         "scale": 2,
11         "type": "number"
12       },
13       "elementId": "elem_4a3c2b1d"
14     },
15     {
16       "columnId": "col_1a2b3c4d",
17       "name": "Order Date",
18       "formula": "Orders.OrderDate",
19       "type": {
20         "format": "yyyy-MM-dd",
21         "type": "date"
22       },
23       "elementId": "elem_4a3c2b1d"
24     },
25     {
26       "columnId": "col_5e6f7g8h",
27       "name": "Customer Name",
28       "formula": "Customers.Name",
29       "type": {
30         "maxLength": 255,
31         "type": "string"
32       },
33       "elementId": "elem_7b8c9d0e"
34     }
35   ],
36   "nextPage": null,
37   "total": 3
38 }

This endpoint retrieves all columns in a data model for all elements in the data model.

Usage notes

Retrieve the dataModelId by calling the /v2/dataModels endpoint.

Usage scenarios

Data exploration: Enable users to explore the data structure of a data model element, facilitating deeper analysis and understanding.
Integration tasks: Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.

Best practices

Use this endpoint when setting up interfaces that require specific knowledge about the data structure.

This endpoint retrieves all columns in a data model for all elements in the data model. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint. ### Usage scenarios - **Data exploration:** Enable users to explore the data structure of a data model element, facilitating deeper analysis and understanding. - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately. ### Best practices - Use this endpoint when setting up interfaces that require specific knowledge about the data structure.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

dataModelIdstringRequired

Query parameters

pagestringOptional

limitdoubleOptional

Response

The response body.

entrieslist of objects

nextPagestring or null

totaldouble