v1

latestOpenAPI 3.1.02026-07-263971,2281.1 MB
DashboardService

CRUD operations

CRUD operations

post/textql.rpc.public.dashboard.DashboardService/CreateDashboard

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

namestring
descriptionstring nullable
codestring
type'DASHBOARD_TYPE_UNSPECIFIED' | 'DASHBOARD_TYPE_STREAMLIT' | 'DASHBOARD_TYPE_HTML' | 'DASHBOARD_TYPE_DASH'
htmlUrlstring nullable
chatIdstring nullable
cellIdstring nullable
folderIdstring nullable

Response

Success

Example response

{
  "dashboard": {
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "refreshedAt": "2023-01-15T01:30:15.01Z",
    "publishedAt": "2023-01-15T01:30:15.01Z",
    "latestScheduledRunAt": "2023-01-15T01:30:15.01Z"
  }
}