LLM-readable documentation index

List Views

Hand off to an LLM

List views in the current environment, optionally filtered by the functions they read from.

Views are tabular projections over transformations rows: each view names one or more functions and a list of columns (JSON-pointer paths into extractedJson), and produces a uniform table that can be filtered, paginated, and aggregated.

Filters AND together when combined. Pagination is cursor-based on viewID; default limit is 50, maximum 100.

GET
/v3/views
x-api-key<token>

Authenticate using API Key in request header

In: header

Query Parameters

limit?integer
Default50
Range1 <= value <= 100
functionIDs?array<>

Return only views that read from at least one of the named functions.

Items1 <= items
functionNames?array<>

Return only views that read from at least one of the named functions.

Items1 <= items
viewIDs?array<>

Return only the specified view IDs.

Items1 <= items
sortOrder?string

Sort order over view IDs (default asc).

Default"asc"
Value in"asc" | "desc"
startingAfter?string

Cursor — a viewID defining your place in the list.

endingBefore?string

Cursor — a viewID defining your place in the list.

viewNameSubstring?string

Case-insensitive substring search over view names.

Response Body

application/json

curl -X GET "https://api.bem.ai/v3/views"
{
  "views": [
    {
      "viewID": "string",
      "name": "string",
      "description": "string",
      "currentVersionNum": 0,
      "columns": [
        {
          "name": "string",
          "valueSchemaPath": [
            "string"
          ],
          "displayOrderIndex": 0
        }
      ],
      "filters": [
        {
          "columnName": "string",
          "filterType": "equals_string",
          "string": "string",
          "number": 0.1
        }
      ],
      "aggregations": [
        {
          "name": "string",
          "function": "count",
          "aggregateColumnName": "string",
          "groupByColumnName": "string",
          "displayType": "table"
        }
      ],
      "functions": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    }
  ],
  "totalCount": 0
}