Skip to main content
PUT
/
widgets
/
{id}
Update dashboard widget
curl --request PUT \
  --url https://app.azalt.co/api/v1/widgets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dashboardId": "<string>",
  "reportSectionId": "<string>",
  "x": 123,
  "y": 123,
  "w": 123,
  "h": 123,
  "name": "<string>",
  "filter": {
    "siteIds": [
      "<string>"
    ],
    "startYear": 123,
    "endYear": 123,
    "startDate": "<string>",
    "endDate": "<string>",
    "statuses": []
  },
  "indicatorId": "<string>",
  "settings": {
    "showTitle": true,
    "indicatorDatasetMappings": {},
    "decimalPlaces": 123,
    "showNumbers": true,
    "showIndicatorName": true,
    "angle": 123,
    "siteGroups": [
      {
        "id": "<string>",
        "name": "<string>",
        "siteIds": [
          "<string>"
        ]
      }
    ],
    "siteGroupIds": [
      "<string>"
    ],
    "selectedTargetEntries": [
      "<string>"
    ],
    "showTargets": true,
    "showContributionShares": true,
    "displayUnitId": "<string>",
    "showGlobalAggregateLines": true,
    "showGlobalAggregateAverageLine": true,
    "globalAggregateTotalLabel": "<string>",
    "globalAggregateAverageLabel": "<string>",
    "showPeerAverageLine": true,
    "peerAverageLabel": "<string>",
    "hideEmptyPeriods": true,
    "useTonBasedReporting": true,
    "showFormElements": true,
    "content": "<string>"
  }
}
'
{
  "id": "<string>",
  "dashboardId": "<string>",
  "reportSectionId": "<string>",
  "relatedModelType": "<string>",
  "relatedModelId": "<string>",
  "name": "<string>",
  "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": []
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
dashboardId
string
reportSectionId
string
x
number
y
number
w
number
h
number
name
string
type
enum<string>
Available options:
line_chart,
bar_chart,
pie_chart,
value,
table,
periodic_values,
text
filter
object
indicatorId
string
settings
object

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,
text
indicatorId
string | null
required
indicatorName
string | null
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