Skip to main content
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": [
    {
      "sourceType": "form_element",
      "formElementId": "<string>",
      "inputIndicatorId": "<string>",
      "value": "<string>",
      "scopeRef": {
        "scope": "site",
        "metric": "value",
        "relativeTo": "group"
      },
      "functionCall": {
        "name": "SUM",
        "fieldPath": "<string>",
        "percentile": 0.5
      }
    }
  ],
  "unitId": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "label": "<string>",
  "description": "<string>",
  "unitId": "<string>",
  "tags": [
    "<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

id
string
required

Body

application/json
label
string
required
description
string
required
datasetItems
string[]
required
variables
object[]
required
unitId
string | null
tags
string[]

Response

Successful response

id
string
required
name
string
required
label
string
required
description
string | null
required
unitId
string | null
required
tags
string[] | null
required
organizationId
string
required
createdAt
string
required
updatedAt
string
required