Skip to main content
POST
Compute chart-ready results (buckets / series / values) for the stored dashboard, a subset of its panels, or ad-hoc panel definitions — optionally scoped to a saved view, a period preset (with the previous interval as previousValue) and extra filters. Same query the strip renders from

Authorizations

Authorization
string
header
required

Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.

Path Parameters

objectName
string
required

Body

application/json
viewName
string

Compute the saved view's own dashboard instead of the object's (ignored when the view inherits).

panelIds
string[]

Only these stored panels.

panels
object[]

Ad-hoc panel definitions to compute instead of the stored dashboard (nothing is persisted). id/title/metric/sortOrder are filled in when omitted.

period
enum<string>

Period preset. Scopes every panel by a date_preset on the object's closeDate role (else $createdAt) and fills previousValue from the previous calendar interval. "all" = no scope.

Available options:
all,
this_week,
this_month,
last_month,
this_quarter,
last_quarter,
this_year
extraFilters
object

FilterGroup applied to every panel (e.g. the view's rules). Forces the bounded scan path.

compareFilters
object

FilterGroup for the comparison window; every panel's value over it comes back as previousValue. Derived automatically from period.

fieldRolesOverride
object

Preview an unsaved role mapping.

drillFilters
object[]

Click-to-filter chips, same as the strip: each scopes every panel EXCEPT those whose dimensions include dimension.

Response

Successful response

objectName
string
required
truncated
boolean
required

True when the table exceeded the 5,000-row scan and numbers are approximate.

scannedRows
number
required
panels
object[]
required
locationRole
string