Skip to main content

PlaybookReportInput

Filters and grouping options for a playbook report.

input PlaybookReportInput {
  aggregationLevel: ActivityMetricsAggregationLevel
  closedAtStartDate: Datetime
  closedAtEndDate: Datetime
  createdAtStartDate: Datetime
  createdAtEndDate: Datetime
  activityStartDate: Datetime
  activityEndDate: Datetime
  groupBy: PlaybookReportGroupBy
  playbookId: String!
  closedStatusFilter: ClosedStatusFilter
  isArchivedFilter: Boolean
  dealStages: [String!]
  accordStatuses: [String!]
}

Fields​

PlaybookReportInput.aggregationLevel ● ActivityMetricsAggregationLevel enum​

Time bucket size for the series: DATE, WEEK, or MONTH. Defaults to DATE when omitted; an explicit null buckets by month. Only CUSTOMER_ACCEPTED (the default groupBy, also used for ACCORD) honors it; every other metric ignores it and buckets by its own fixed date, or returns a single unbucketed row for OPPORTUNITY_AMOUNT.

PlaybookReportInput.closedAtStartDate ● Datetime scalar​

Only include accords/deals closed on or after this date.

PlaybookReportInput.closedAtEndDate ● Datetime scalar​

Only include accords/deals closed on or before this date.

PlaybookReportInput.createdAtStartDate ● Datetime scalar​

Only include accords/deals created on or after this date.

PlaybookReportInput.createdAtEndDate ● Datetime scalar​

Only include accords/deals created on or before this date.

PlaybookReportInput.activityStartDate ● Datetime scalar​

Only include activity on or after this date.

PlaybookReportInput.activityEndDate ● Datetime scalar​

Only include activity on or before this date.

PlaybookReportInput.groupBy ● PlaybookReportGroupBy enum​

The metric to aggregate and group the report by.

PlaybookReportInput.playbookId ● String! non-null scalar​

The playbook to report on.

PlaybookReportInput.closedStatusFilter ● ClosedStatusFilter enum​

Restrict to closed-won or closed-lost deals. Honored by OPPORTUNITY_AMOUNT and the closed-won/lost counts only; the averages and CUSTOMER_ACCEPTED ignore it.

PlaybookReportInput.isArchivedFilter ● Boolean scalar​

When set, filter accords by their archived state.

PlaybookReportInput.dealStages ● [String!] list scalar​

Restrict to accords whose linked CRM deal is in one of these stages. Ignored by COUNT_CLOSED_WON and COUNT_CLOSED_LOST, which never apply the stage filter.

PlaybookReportInput.accordStatuses ● [String!] list scalar​

Restrict to accords in one of these statuses.

Member Of​

playbookReport query