Skip to main content

PlaybookReportGroupBy

The metric the playbook report aggregates and groups its rows by.

enum PlaybookReportGroupBy {
ACCORD
AVERAGE_CUSTOMER_VALUE
AVERAGE_TIME_TO_CLOSE
COUNT_CLOSED_WON
COUNT_CLOSED_LOST
CUSTOMER_ACCEPTED
OPPORTUNITY_AMOUNT
}

Values

PlaybookReportGroupBy.ACCORD

Falls through to the CUSTOMER_ACCEPTED metric; it does not produce an accord count.

PlaybookReportGroupBy.AVERAGE_CUSTOMER_VALUE

Mean opportunity amount per accord (accords with no amount count as zero), bucketed by the CRM deal's creation date, falling back to the accord's own when the deal's is unset.

PlaybookReportGroupBy.AVERAGE_TIME_TO_CLOSE

Mean days from the CRM deal's creation date (the accord's own when the deal's is unset) to the close date, bucketed by close date. Only accords that closed on or after they were created are counted.

PlaybookReportGroupBy.COUNT_CLOSED_WON

Count of closed-won accords, bucketed by close date. Restricts to closed-won on its own; closedStatusFilter need not be set.

PlaybookReportGroupBy.COUNT_CLOSED_LOST

Count of closed-lost accords, bucketed by close date. Restricts to closed-lost on its own, unless closedStatusFilter is CLOSED_WON, which takes precedence.

PlaybookReportGroupBy.CUSTOMER_ACCEPTED

The default. Count of customer members who accepted their invitation, with the invited count as totalCount, bucketed by activity date at aggregationLevel.

PlaybookReportGroupBy.OPPORTUNITY_AMOUNT

Total opportunity amount across the matching accords, returned as a single row with no date.

Member Of

PlaybookReportInput input