crm

Generate report

Generate a CRM report.

post/crm/reports

Request

  • Base URL
    https://www.dench.com/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

objectNamestring required
type'pie' | 'bar' | 'line' | 'table' required

Chart type for the generated report.

groupByFieldstring required
metric'count' | 'sum' | 'avg' | 'min' | 'max'

Aggregation metric. Defaults to count.

metricFieldstring

Number field to sum/avg per bucket (e.g. Amount grouped by Stage). Defaults to the group field itself.

Response

Successful response

totalCountnumber required
truncatedboolean

True when a bounded row scan (not the exact pre-aggregates) produced the sums.

Changes

No recorded changes to this operation across all 1 revision of this API.