Views
List Views
List all views with optional filtering by function IDs.
Authorization
API Key x-api-key<token>
Authenticate using API Key in request header
In: header
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100functionIDs?array<string>
Filter views by function IDs. Returns views that query transformations from the specified functions.
Items
1 <= itemsfunctionNames?array<string>
Filter views by function names. Returns views that query transformations from the specified functions.
Items
1 <= itemsviewIDs?array<string>
Filter views by view IDs.
Items
1 <= itemssortOrder?string
Sort order for the list of views. Defaults to asc.
Default
"asc"Value in
"asc" | "desc"startingAfter?string
A cursor to use in pagination. startingAfter is a view ID that defines your place in the list.
endingBefore?string
A cursor to use in pagination. endingBefore is a view ID that defines your place in the list.
viewNameSubstring?string
Used for search over view names. Will perform case-insensitive substring matching.
Response Body
application/json
curl -X GET "https://api.bem.ai/v2/views?functionIDs=f_2N6gH8ZKCmvb6BnFcGqhKJ98VzP"{
"views": [
{
"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"
}
]
}
],
"totalCount": 10
}