CustomFieldBreakdown

Documents counted and valued by the values of one custom field, in the reader's analytics scope.

type CustomFieldBreakdown {
  fieldType: String
  groupByKey: String
  groupByOwner: CustomFieldBreakdownOwner
  groups: [CustomFieldBreakdownGroup!]!
  record: CustomFieldBreakdownRecord!
  scope: AnalyticsScope!
  totalAmount: Float!
  totalCount: Int!
}

Fields

CustomFieldBreakdown.fieldType ● String scalar

The grouped field's type (select or boolean); null without a group-by.

CustomFieldBreakdown.groupByKey ● String scalar

The grouped field's key; null without a group-by.

CustomFieldBreakdown.groupByOwner ● CustomFieldBreakdownOwner enum

Whose field the groups come from; null without a group-by.

CustomFieldBreakdown.groups ● [CustomFieldBreakdownGroup!]! non-null object

One group per value, largest value first, with documents holding no value as a final group (value null). One group without a group-by.

CustomFieldBreakdown.record ● CustomFieldBreakdownRecord! non-null enum

Which documents were counted.

CustomFieldBreakdown.scope ● AnalyticsScope! non-null enum

The scope the server applied after limiting the request.

CustomFieldBreakdown.totalAmount ● Float! non-null scalar

Their total value in the organization's base currency.

CustomFieldBreakdown.totalCount ● Int! non-null scalar

How many documents matched in all.

Returned By

customFieldBreakdown query