Hodoflow / Developers
Sign in
Browse documentation
Help Center →
Browse API reference

JSON:API · v1

Dashboards

Manage dashboards, widgets, and widget placements.

Bearer authentication api_read / api_write by operation Stable

Operations

GET List widget placements /api/json/v1/dashboard_widgets List widget placements visible to the authenticated service account. GET Retrieve a widget placement /api/json/v1/dashboard_widgets/{id} Retrieve one widget placement visible to the authenticated service account. PATCH Update a widget placement /api/json/v1/dashboard_widgets/{id} Update the supported fields of one widget placement. GET List dashboards /api/json/v1/dashboards List dashboards visible to the authenticated service account. POST Create a dashboard /api/json/v1/dashboards Create a new dashboard in the service account's workspace. GET Retrieve a dashboard /api/json/v1/dashboards/{id} Retrieve one dashboard visible to the authenticated service account. PATCH Update a dashboard /api/json/v1/dashboards/{id} Update the supported fields of one dashboard. GET List widgets /api/json/v1/widgets List widgets visible to the authenticated service account. POST Create a widget /api/json/v1/widgets Create a new widget in the service account's workspace. GET Retrieve a widget /api/json/v1/widgets/{id} Retrieve one widget visible to the authenticated service account. PATCH Update a widget /api/json/v1/widgets/{id} Update the supported fields of one widget.

Objects and fields

These are the reviewed public attributes. Fields omitted from this contract are not part of the API, even when they exist internally.

Dashboard type: dashboard 6 fields

Public JSON:API resource object for dashboards.

Field Type Presence Description
created_by_id string | null Optional · nullable Created by id returned by the public contract.
description string | null Optional · nullable Human-readable description.
filters object | null Optional · nullable Author-baseline filter set applied to all widgets on this dashboard; merged with widget filters and runtime overlays. Field included by default.
is_public boolean Required Whether this dashboard is publicly embeddable. Field included by default.
name string Required Human-readable resource name.
organization_id string Required Organization that owns the resource.
Widget placement type: dashboard_widget 3 fields

Public JSON:API resource object for widget placements.

Field Type Presence Description
dashboard_id string Required Dashboard id returned by the public contract.
position object Required Grid position and size: {x, y, w, h}. Field included by default.
widget_id string Required Widget id returned by the public contract.
Widget type: widget 9 fields

Public JSON:API resource object for widgets.

Field Type Presence Description
config object Required Type-specific configuration (columns, fields, aggregations, etc.). Field included by default.
data_model_id string | null Optional · nullable Data model id returned by the public contract.
embed_filter_allowlist array<string> Required Filter dimensions a public embedder may override at runtime. Defaults to allowing time_range; clear the array to lock all filters. Field included by default.
filters object | null Optional · nullable Author-baseline filter set (e.g. time-range constraint) layered with dashboard/runtime overlays at read time. Field included by default.
is_public boolean Required Whether this widget is publicly embeddable. Field included by default.
name string Required Human-readable resource name.
organization_id string Required Organization that owns the resource.
source enum: dashboard | library Required Origin: :dashboard (inline, auto-cleaned) or :library (standalone). Field included by default.
type enum: line_chart | bar_chart | map_chart | table | stat_card | markdown | heatmap | activity_feed | pivot_table | pie_chart Required Widget visualization type. Field included by default.