Views

Get a View

Retrieve a single view by its ID.

GET
/v2/views/{view_id}
x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

view_id*string

Unique identifier of the view

Response Body

application/json

curl -X GET "https://api.bem.ai/v2/views/v_2N6gH8ZKCmvb6BnFcGqhKJ98VzP"
{
  "viewID": "v_2N6gH8ZKCmvb6BnFcGqhKJ98VzP",
  "name": "Invoice Overview",
  "description": "This view provides an overview of all invoices.",
  "displayType": "table",
  "currentVersionNum": 1,
  "columns": [
    {
      "name": "Invoice Number",
      "valueSchemaPath": [
        "invoiceDetails",
        "invoiceNumber"
      ],
      "displayOrderIndex": 0
    }
  ],
  "filters": [
    {
      "columnName": "Invoice Amount",
      "filterType": "equals_string",
      "string": "INV-123",
      "number": 1000
    }
  ],
  "aggregations": [
    {
      "name": "Total Revenue",
      "function": "count",
      "aggregateColumnName": "Invoice Amount",
      "groupByColumnName": "Customer Name"
    }
  ],
  "functions": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}