SQL

dashboard.update

Update a dashboard

Details

Endpoint: PUT /v1/dashboard/:dashboard
Credits: Free
Rate class: Light. Counts against your light requests per second.
Also called: /v1/dashboard/:dashboard/update

Changes any of name, slug, description, widgets, params, theme, refresh_sec, tags, is_private or is_archived. Owner only. PUT, or POST to /v1/dashboard/{dashboard}/update.

Parameters

Name	Type	Description
name	string
slug	string
description	string
widgets	array of any	[{ id, kind: viz \| text \| section, query_id, viz_id, text, title, link?, x, y, w, h }] on a 12 column grid. A section may carry link: { label, href } shown beside its title.
params	array of any	Shared filters: [{ key, type: text \| number \| date \| list, value, options?, label? }]. A filter applies to every widget whose query has a parameter with the same key.
theme	string	One of "dark", "light".
refresh_sec	integer	Re-run every widget's query this often (10 s to 7 days, 0 = never). Short schedules run while someone is viewing.
tags	array of any
links	array of any	Up to 4 outward links shown in the header: [{ label, href }], href a full https URL.
is_private	boolean
dashboardrequired	string
is_archived	boolean

Request

Send your key in the x-api-key header, or leave it out to use the keyless tier.

curl

curl -X PUT "https://api.tide.ad/v1/dashboard/my-dashboard" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "name": "Renamed"
}'

TypeScript

const res = await fetch("https://api.tide.ad/v1/dashboard/my-dashboard", {
  method: "PUT",
  headers: {
    "x-api-key": process.env.TIDE_API_KEY!,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "name": "Renamed"
  }),
});
const data = await res.json();

Response

No example response is available for this method yet.