Skip to main content
GET
/
widgets
List widgets
curl --request GET \
  --url https://app.azalt.co/api/v1/widgets
[
  {
    "id": "<string>",
    "dashboardId": "<string>",
    "reportSectionId": "<string>",
    "relatedModelType": "<string>",
    "relatedModelId": "<string>",
    "name": "<string>",
    "type": "line_chart",
    "indicatorId": "<string>",
    "indicatorName": "<string>",
    "indicatorLabel": "<string>",
    "x": 123,
    "y": 123,
    "w": 123,
    "h": 123,
    "settings": {},
    "filter": {
      "siteIds": [
        "<string>"
      ],
      "startYear": 123,
      "endYear": 123,
      "startDate": "<string>",
      "endDate": "<string>",
      "statuses": [
        "COMPLETED"
      ]
    }
  }
]

Query Parameters

dashboardId
string
reportSectionId
string

Response

Successful response

id
string
required
dashboardId
string | null
required
reportSectionId
string | null
required
name
string
required
type
enum<string>
required
Available options:
line_chart,
bar_chart,
pie_chart,
value,
table,
periodic_values
indicatorId
string
required
indicatorName
string
required
indicatorLabel
string | null
required
x
number | null
required
y
number | null
required
w
number | null
required
h
number | null
required
settings
object
required
filter
object
required