ackDB

Update a dashboard (patch)

Edit access or better. An OMITTED field is left alone; an explicit null CLEARS description / artifact / layout (the SET list is built from the keys actually present). An empty patch does not bump updatedAt. Panels are re-validated, but only panels whose (segmentId, type, spec) actually MOVED are re-checked against the caller's segment access: an editor without access to a private segment may rename and rearrange, just not REPOINT.

put/api/v1/ackdb/observe/dashboards/{id}

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

idstring required

Dashboard id (ULID).

Request body

namestring
descriptionstring nullable
layoutunknown

Example request

{
  "panels": [
    {
      "spec": {
        "metric": {
          "eventType": "invoice.paid"
        }
      },
      "degradedReason": "segment deleted"
    }
  ]
}

Response

The updated dashboard.

Example response

{
  "data": {
    "panels": [
      {
        "spec": {
          "metric": {
            "eventType": "invoice.paid"
          }
        },
        "degradedReason": "segment deleted"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.