Skip to main content
POST
Generate report

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.

Body

application/json
objectName
string
required
type
enum<string>
required

Chart type for the generated report.

Available options:
pie,
bar,
line,
table
groupByField
string
required
metric
enum<string>

Aggregation metric. Defaults to count.

Available options:
count,
sum,
avg,
min,
max
metricField
string

Response

Successful response

spec
object
required
buckets
object[]
required
totalCount
number
required