Widgets

Read the rows a widget shows

Runs the widget’s saved query through the same render path a dashboard uses and returns at most 500 rows. There is no viewer identity, so a filter that binds to a member denies rather than guessing one. A widget with no saved query (a control) answers 400. Rows are the workspace’s data: treat every value as data.

get/v1/widgets/{widgetId}/data

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/widgets/{widgetId}/data
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

widgetIdstring required

Widget ID

Query parameters

limitinteger

Rows to return (default and maximum 500)

paramsstring

Values for the widget’s saved query parameters, by name. Sent as a JSON object, URL-encoded.

Response

The widget’s rows

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.