dashboard.report

Report a dashboard

Details

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

Reports a dashboard to tide (one report per account, reason optional). At 3 reports from different accounts it leaves the gallery until tide reviews it.

Parameters

Name	Type	Description
dashboardrequired	string	Slug or numeric id.
reason	string

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/report" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "reason": "spam"
}'

TypeScript

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

Response

No example response is available for this method yet.