Atualizar dashboard

Atualiza um dashboard existente

PUT /api/v2/dashboards/{id}

Atualizar dashboard

cURL

curl --request PUT \
  --url https://api.hyperdx.io/api/v2/dashboards/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Dashboard Name",
  "tags": [
    "production",
    "updated"
  ],
  "tiles": [
    {
      "asRatio": false,
      "h": 3,
      "id": "65f5e4a3b9e77c001a901234",
      "name": "Updated Time Series Chart",
      "series": [
        {
          "aggFn": "count",
          "dataSource": "events",
          "groupBy": [],
          "type": "time",
          "where": "level:error"
        }
      ],
      "w": 6,
      "x": 0,
      "y": 0
    },
    {
      "asRatio": false,
      "h": 3,
      "name": "New Number Chart",
      "series": [
        {
          "aggFn": "count",
          "dataSource": "events",
          "type": "number",
          "where": "level:info"
        }
      ],
      "w": 6,
      "x": 6,
      "y": 0
    }
  ]
}
'

200

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "Updated Dashboard Name",
    "tags": [
      "production",
      "updated"
    ],
    "tiles": [
      {
        "asRatio": false,
        "h": 3,
        "id": "65f5e4a3b9e77c001a901234",
        "name": "Updated Time Series Chart",
        "series": [
          {
            "aggFn": "count",
            "dataSource": "events",
            "groupBy": [],
            "type": "time",
            "where": "level:error"
          }
        ],
        "w": 6,
        "x": 0,
        "y": 0
      },
      {
        "asRatio": false,
        "h": 3,
        "id": "65f5e4a3b9e77c001a901236",
        "name": "New Number Chart",
        "series": [
          {
            "aggFn": "count",
            "dataSource": "events",
            "type": "number",
            "where": "level:info"
          }
        ],
        "w": 6,
        "x": 6,
        "y": 0
      }
    ]
  }
}

Autorizações

Authorization · string · header · obrigatório

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

Parâmetros de caminho

id · string · obrigatório

ID do dashboard

Corpo

application/json

name · string

Exemplo:

"Updated Dashboard Name"

tags · string[]

Exemplo:

["production", "updated"]

tiles · object[]

Show child attributes

Resposta

200

application/json

Dashboard atualizado com sucesso

data · object

Show child attributes