Update indicator

curl --request PUT \
  --url https://app.azalt.co/api/v1/indicators/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>",
  "datasetItems": [
    "<string>"
  ],
  "variables": [
    {
      "formElementId": "<string>",
      "inputIndicatorId": "<string>",
      "value": "<string>"
    }
  ],
  "unitId": "<string>",
  "displayUnitId": "<string>",
  "tags": [
    "<string>"
  ],
  "preferredDatasetItemName": "<string>",
  "preferredDatasetItemDatasetId": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "label": "<string>",
  "description": "<string>",
  "unitId": "<string>",
  "displayUnitId": "<string>",
  "tags": [
    "<string>"
  ],
  "preferredDatasetItemName": "<string>",
  "preferredDatasetItemDatasetId": "<string>",
  "organizationId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Indicator

Update indicator

Update an existing indicator’s configuration, mathematical expression, or metadata.

Updatable Fields:

Name and description
Mathematical expression and calculation logic
Units of measurement and formatting
Dataset associations and coefficient mappings
Visibility and access permissions

Impact Considerations:

Changes to mathematical expressions affect all dependent calculations
Historical data calculations may be impacted
Dashboard widgets using this indicator will reflect changes
Dependent indicators may require recalculation

Safety Features:

Validation prevents breaking existing dependencies
Circular reference detection for formula modifications
Version tracking for audit and rollback purposes
Impact analysis before applying changes

Requires site manager permissions due to the potential organizational impact of indicator modifications.

PUT

indicators

{id}

Update indicator

curl --request PUT \
  --url https://app.azalt.co/api/v1/indicators/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>",
  "datasetItems": [
    "<string>"
  ],
  "variables": [
    {
      "formElementId": "<string>",
      "inputIndicatorId": "<string>",
      "value": "<string>"
    }
  ],
  "unitId": "<string>",
  "displayUnitId": "<string>",
  "tags": [
    "<string>"
  ],
  "preferredDatasetItemName": "<string>",
  "preferredDatasetItemDatasetId": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "label": "<string>",
  "description": "<string>",
  "unitId": "<string>",
  "displayUnitId": "<string>",
  "tags": [
    "<string>"
  ],
  "preferredDatasetItemName": "<string>",
  "preferredDatasetItemDatasetId": "<string>",
  "organizationId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

label

string

required

description

string

required

datasetItems

string[]

required

variables

object[]

required

Show child attributes

unitId

string | null

displayUnitId

string | null

Response

Successful response

string

required

name

string

required

label

string

required

description

string | null

required

unitId

string | null

required

displayUnitId

string | null

required