SQL

dashboard.run

Run a dashboard with filter values

Details

Endpoint: POST /v1/dashboard/:dashboard/run
Credits: varies
Pricing: Depends on the input and the size of the result. The description says how.
Rate class: Heavy. Counts against your heavy requests per second.

Runs every widget's query with the dashboard's filters set to params ({ key: value }) and returns { query_id: execution_id }; poll each like sql.execute. Identical runs from the last max_age seconds (default 60) are reused for 2 credits; new runs cost 20 plus 1 per 50 MB read, charged to the caller.

Parameters

Name	Type	Description
dashboardrequired	string	Slug or numeric id.
params	object
max_age	integer

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

TypeScript

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

Response

No example response is available for this method yet.