Dashboard RPC Calls
This page documents the gRPC-Web endpoints for dashboard operations. These endpoints provide the same functionality as the HTTP API but use the gRPC-Web protocol.
For instructions on encoding and decoding gRPC-Web requests, see Handling gRPC-Web Requests.
AddDashboardRow
Add a single row to a dashboard.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/AddDashboardRow |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
| Header | Type | Required | Description |
|---|
Authorization | string | Yes | Bearer token |
Content-Type | string | Yes | application/grpc-web+proto |
x-grpc-web | string | Yes | 1 |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
column_values | map<string, ColumnValue> | Yes | Input column values |
Response
| Field | Type | Description |
|---|
row_id | string | UUID of the created row |
UpdateDashboardRow
Update column values in an existing row.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/UpdateDashboardRow |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
row_id | string | Yes | UUID of the row |
dashboard_id | string | Yes | UUID of the dashboard |
column_values | map<string, ColumnValue> | Yes | Updated column values |
DeleteDashboardRows
Delete one or more rows from a dashboard.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/DeleteDashboardRows |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
row_ids | repeated string | Yes | List of row UUIDs to delete |
GetDashboardRows
Retrieve rows from a dashboard with optional filtering and pagination.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/GetDashboardRows |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
page_size | int32 | No | Number of rows per page |
page_token | string | No | Pagination token |
filter | string | No | Filter expression |
minimal_row_values | bool | No | Return minimal column values |
Response
| Field | Type | Description |
|---|
rows | repeated DashboardRow | Dashboard rows |
next_page_token | string | Token for the next page |
total_count | int32 | Total number of matching rows |
TriggerWorkflowForRow
Trigger workflow execution for a specific row.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/TriggerWorkflowForRow |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
row_id | string | Yes | UUID of the row to trigger |
Response
| Field | Type | Description |
|---|
workflow_run_id | string | UUID of the workflow execution |
TriggerWorkflowForRemaining
Trigger workflow execution for all rows that have not yet been processed.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/TriggerWorkflowForRemaining |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
Response
| Field | Type | Description |
|---|
triggered_row_ids | array | UUIDs of the rows that were triggered |
ContinueWorkflowForRow
Submit a HITL response to resume a paused workflow for a row.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/ContinueWorkflowForRow |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
row_id | string | Yes | UUID of the paused row |
response | object | Yes | User's response to the HITL prompt |
GetContinuationMessageForRow
Retrieve the HITL continuation message for a paused row.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/GetContinuationMessageForRow |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
row_id | string | Yes | UUID of the paused row |
Response
Returns the HITL message that the workflow is waiting on, including message type (form, buttons, or text) and the message content.
GetDashboardSchema
Retrieve the schema (column definitions) for a dashboard.
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/GetDashboardSchema |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
Response
| Field | Type | Description |
|---|
columns | repeated ColumnDetails | Column definitions for the dashboard |
DownloadDashboardRows
Download dashboard rows as a file (XLSX or CSV).
| Property | Value |
|---|
| URL | /workflows.v1.DashboardsService/DownloadDashboardRows |
| HTTP Method | POST |
| Protocol | gRPC-Web over HTTP |
Request
| Field | Type | Required | Description |
|---|
dashboard_id | string | Yes | UUID of the dashboard |
format | string | No | File format (xlsx or csv) |
Response
Returns the dashboard data as a downloadable file.