Generate View Table Data

Generate paginated table data for a view.

Executes the view's query against transformations rows produced by the named functions inside the supplied timeWindow, applies the view's filters, and returns matching rows. Each row reports the event eventID (externally-stable KSUID) plus the projected column values.

The functions field is required — at least one functionID or functionName must be supplied. limit defaults to 50 with a maximum of 200; offset is zero-based. The response's totalCount reflects the match count before pagination, so paging can be driven off it.

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Name of the view

description?string

Description of the view

columns*array<>

List of columns in the view

filters*array<>

List of filters applied to the view

aggregations*array<>

List of aggregations defined for the view

functions*array<>

List of functions that this view queries transformations from

timeWindow*

Time window for filtering transformations in a view

limit?|

Maximum number of rows to return (default: 50, max: 200)

Range1 <= value <= 200

offset?|

Number of rows to skip for pagination

Range0 <= value

Response Body

`application/json`

curl -X POST "https://api.bem.ai/v3/views/table-data" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "columns": [      {        "name": "string",        "valueSchemaPath": [          "string"        ],        "displayOrderIndex": 0      }    ],    "filters": [      {        "columnName": "string",        "filterType": "equals_string"      }    ],    "aggregations": [      {        "name": "string",        "function": "count"      }    ],    "functions": [      {}    ],    "timeWindow": {      "start": "2019-08-24T14:15:22Z",      "end": "2019-08-24T14:15:22Z"    }  }'

{
  "rows": [
    {
      "columns": [
        {
          "columnName": "string",
          "value": "string"
        }
      ],
      "eventID": "string"
    }
  ],
  "totalCount": 0
}

{
  "message": "string",
  "code": 0,
  "details": {}
}

Generate View Table Data

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`