dashboard.star

Star or unstar a dashboard

Details

Endpoint: POST /v1/dashboard/:dashboard/star
Credits: Free
Rate class: Light. Counts against your light requests per second.

Stars a dashboard (on: true, the default) or removes your star (on: false). Returns the star count.

Parameters

Name	Type	Description
dashboardrequired	string	Slug or numeric id.
on	boolean

Request

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

curl

curl -X POST "https://api.tide.ad/v1/dashboard/sui-pulse/star" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

TypeScript

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

Response

No example response is available for this method yet.