DEdench
crm

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

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.

post/crm/objects/{objectName}/analytics/compute

Request

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

Path parameters

objectNamestring required

Request body

viewNamestring

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

panelIdsstring[]

Only these stored panels.

period'all' | 'this_week' | 'this_month' | 'last_month' | 'this_quarter' | 'last_quarter' | 'this_year'

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.

extraFiltersobject

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

compareFiltersobject

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

assignedTostring

Personal scope: "me" (the signed-in member / the human behind an agent session), "unassigned", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view.

assigneeFieldstring

Which user field "assigned" means. Default: the analytics owner role, else the task Assignee, else a user field named like owner/assignee, else the first user field.

Response

Successful response

objectNamestring required
truncatedboolean required

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

scannedRowsnumber required
locationRolestring

Changes

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