HOhoneybadger
Dashboards

Update a dashboard

Updates an Insights dashboard. Fields left out keep their values. widgets replaces the whole list, so send every widget you want to keep; a widget sent without its id gets a new one.

patch/projects/{project_id}/dashboards/{dashboard_id}

Request

Path parameters

project_idstring required
Example:Xk9mZp

Project ID

dashboard_idstring required
Example:Db4rKn

Dashboard ID

Request body

titlestring
default_tsstring nullable

Default time range. Null clears it.

Example request

{
  "title": "Production overview",
  "widgets": [
    {
      "presentation": {
        "title": "Checkout errors",
        "subtitle": "Last 24 hours"
      }
    }
  ]
}

Response

Success

Example response

{
  "data": {
    "id": "Db4rKn",
    "project_id": "Xk9mZp",
    "title": "Performance Overview",
    "widgets": [
      {
        "id": "checkout-errors",
        "presentation": {
          "title": "Checkout errors",
          "subtitle": "Last 24 hours"
        }
      }
    ],
    "default_ts": "PT3H",
    "links": {
      "web": "https://app.honeybadger.io/projects/Xk9mZp"
    }
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

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