List dashboard widgets

get

https://management.api.exabel.com/v1/dashboards/{dashboardId}/widgets

Chart widgets can be rendered as images with the "Export chart" method in the Export API, using the widget resource name returned here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

dashboardId

integer

required

The ID of a dashboard, e.g. 1234.

Query Params

widgetType

string

enum

Defaults to WIDGET_TYPE_UNSPECIFIED

The type of widgets to list. If not set, all types are included in the result.

WIDGET_TYPE_UNSPECIFIED: The widget type is unspecified. In a request this means every type; in a response it is not expected, and means a widget whose type could not be determined.
WIDGET_TYPE_CHART: A chart. Only these can be rendered with the Export API.
WIDGET_TYPE_SIGNALS_TABLE: A table of cells consisting of signal data.
WIDGET_TYPE_FINANCIAL_MODEL: A financial model.
WIDGET_TYPE_TEXT: Text.
WIDGET_TYPE_PORTFOLIO: A table of cells consisting of portfolio data.

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.