Skip to main content
GET
/
analytics
/
widgets
List Widgets
curl --request GET \
  --url https://api.decodahealth.com/analytics/widgets \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "dashboardId": "<string>",
    "title": "<string>",
    "chartType": "<string>",
    "queryConfig": {
      "table": "<string>",
      "fields": [
        "<string>"
      ],
      "filters": [
        {}
      ],
      "aggregations": {},
      "groupBy": [
        "<string>"
      ],
      "temporalGrouping": {},
      "orderBy": {}
    },
    "layoutPosition": {},
    "isArchived": true,
    "orderIndex": 123,
    "createdDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "chartConfig": {},
    "updatedDate": "2023-11-07T05:31:56Z"
  }
]

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
dashboard_id
string | null

Filter by dashboard ID

chart_type
string | null

Filter by chart type

is_archived
boolean | null

Filter by archived status

Response

Successful Response

id
string
required

Unique identifier for the widget

dashboardId
string
required

ID of the dashboard this widget belongs to

title
string
required

Title of the widget

chartType
string
required

Type of chart

queryConfig
QueryConfigSchema · object
required

Query builder configuration

layoutPosition
Layoutposition · object
required

Grid position and size

isArchived
boolean
required

Whether the widget is archived

orderIndex
integer
required

Order index for widget positioning

createdDate
string<date-time>
required

When the widget was created

description
string | null

Description of the widget

chartConfig
Chartconfig · object

Chart-specific configuration

updatedDate
string<date-time> | null

When the widget was last updated