GraphQL RepositoriesinterfacePreview

`entities.interfacePreview`

Read interface preview records with the interfacePreview repository, and change them with the interface preview mutations. Same records as the REST InterfacePreviews entity.

Example: first three interface preview recordsGraphQLcURL

query FirstInterfacePreviews {
  entities {
    interfacePreview {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstInterfacePreviews { entities { interfacePreview { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { interfacePreview { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	InterfacePreviewEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[InterfacePreviewEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: InterfacePreviewFilterInput, orderBy: [InterfacePreviewOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[InterfacePreviewEntity!]!
QUERY	`getByCriteria`(filter: InterfacePreviewFilterInput, orderBy: [InterfacePreviewOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[InterfacePreviewEntity!]!
QUERY	`getPublished`(limit: Int, offset: Int, filter: InterfacePreviewFilterInput, orderBy: [InterfacePreviewOrderByInput!], includeDeleted: Boolean) Returns the published records that match the filter, paged with limit and offset.	[InterfacePreviewEntity!]!
QUERY	`getDrafts`(filter: InterfacePreviewFilterInput, orderBy: [InterfacePreviewOrderByInput!]) Returns the records that match the filter, with pending unpublished changes applied where a draft exists.	[InterfacePreviewEntity!]!
QUERY	`getDraftById`(entityId: ID!) Returns the record with the given id, with its pending unpublished changes applied when a draft exists.	InterfacePreviewEntity!

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

InterfacePreviewEntity object 38 fields: isDeleteProtected, hasDraft, id, …

Layout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`hasDraft`	Boolean	True when the record has unpublished draft changes, including pending translation changes, that can be published.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`accountType`	AccountTypeEntity	Account type the interface preview applies to.
`appointmentType`	AppointmentTypeEntity	Appointment type the interface preview applies to.
`contactType`	ContactTypeEntity	Contact type the interface preview applies to.
`customEntityType`	CustomEntityTypeEntity	Custom entity type the interface preview applies to.
`leadType`	LeadTypeEntity	Lead type the interface preview applies to.
`opptyType`	OpportunityTypeEntity	Opportunity type the interface preview applies to.
`productType`	ProductTypeEntity	Product type the interface preview applies to.
`projectType`	ProjectTypeEntity	Project type the interface preview applies to.
`quoteType`	QuoteTypeEntity	Quote type the interface preview applies to.
`taskType`	TaskTypeEntity	Task type the interface preview applies to.
`accountTypeId`	ID	Id of the account type the interface preview applies to.
`appointmentTypeId`	ID	Id of the appointment type the interface preview applies to.
`cardFieldIds`	[UUID!]!	Ordered ids of fields shown on the record's compact card view.
`charts`	[InterfacePreviewChart!]!	Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments).
`contactTypeId`	ID	Id of the contact type the interface preview applies to.
`customEntityTypeId`	ID	Id of the custom entity type the interface preview applies to.
`detailTabs`	[InterfaceDetailTab!]!	Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs).
`detailWidgets`	[InterfaceDetailWidget!]!	Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs).
`fieldIds`	[UUID!]!	Ordered ids of fields shown in the record's preview pane.
`leadTypeId`	ID	Id of the lead type the interface preview applies to.
`opptyTypeId`	ID	Id of the opportunity type.
`productTypeId`	ID	Id of the product type the interface preview applies to.
`projectTypeId`	ID	Id of the project type the interface preview applies to.
`quoteTypeId`	ID	Id of the quote type the interface preview applies to.
`settings`	InterfacePreviewCustomSettings!	Layout-customization settings for the preview (e.g. isLayoutCustomizationEnabled). This payload conforms to the `InterfacePreviewCustomSettings` JSON Schema: GET /api/v100/rest/schemas/InterfacePreviewCustomSettings.json on your region's API host
`taskTypeId`	ID	Id of the task type the interface preview applies to.
`isPublished`	Boolean	True when the interface preview is published; false while it exists only as an unpublished draft.
`revision`	Int	Revision when entity was lastly changed.
`entityTypeId`	UUID!	Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set.
`entityApiName`	String	For custom entities, the API name of the targeted custom entity. Empty when the preview targets a built-in entity (use entityType to identify it).
`entityType`	BaseEntityTypeEnum!	Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived from whichever of the per-entity-type relations is set.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

InterfacePreviewFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for InterfacePreview records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[InterfacePreviewFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[InterfacePreviewFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	InterfacePreviewFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`accountTypeId`	EntityFilterStringField	Id of the account type the interface preview applies to.
`appointmentTypeId`	EntityFilterStringField	Id of the appointment type the interface preview applies to.
`contactTypeId`	EntityFilterStringField	Id of the contact type the interface preview applies to.
`customEntityTypeId`	EntityFilterStringField	Id of the custom entity type the interface preview applies to.
`leadTypeId`	EntityFilterStringField	Id of the lead type the interface preview applies to.
`opptyTypeId`	EntityFilterStringField	Id of the opportunity type.
`productTypeId`	EntityFilterStringField	Id of the product type the interface preview applies to.
`projectTypeId`	EntityFilterStringField	Id of the project type the interface preview applies to.
`quoteTypeId`	EntityFilterStringField	Id of the quote type the interface preview applies to.
`taskTypeId`	EntityFilterStringField	Id of the task type the interface preview applies to.
`isPublished`	Boolean	True when the interface preview is published; false while it exists only as an unpublished draft.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`entityTypeId`	UUID	Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set.
`entityApiName`	String	For custom entities, the API name of the targeted custom entity. Empty when the preview targets a built-in entity (use entityType to identify it).
`entityType`	BaseEntityTypeEnum	Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived from whichever of the per-entity-type relations is set.
`accountType`	AccountTypeFilterInput	Account type the interface preview applies to. Matches records where a related record meets these conditions.
`appointmentType`	AppointmentTypeFilterInput	Appointment type the interface preview applies to. Matches records where a related record meets these conditions.
`contactType`	ContactTypeFilterInput	Contact type the interface preview applies to. Matches records where a related record meets these conditions.
`customEntityType`	CustomEntityTypeFilterInput	Custom entity type the interface preview applies to. Matches records where a related record meets these conditions.
`leadType`	LeadTypeFilterInput	Lead type the interface preview applies to. Matches records where a related record meets these conditions.
`opptyType`	OpportunityTypeFilterInput	Opportunity type the interface preview applies to. Matches records where a related record meets these conditions.
`productType`	ProductTypeFilterInput	Product type the interface preview applies to. Matches records where a related record meets these conditions.
`projectType`	ProjectTypeFilterInput	Project type the interface preview applies to. Matches records where a related record meets these conditions.
`quoteType`	QuoteTypeFilterInput	Quote type the interface preview applies to. Matches records where a related record meets these conditions.
`taskType`	TaskTypeFilterInput	Task type the interface preview applies to. Matches records where a related record meets these conditions.

InterfacePreviewOrderByInput input Asc or Desc per field

Sorting of InterfacePreview records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`accountType`	[AccountTypeOrderByNestedInput!]	Account type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`appointmentType`	[AppointmentTypeOrderByNestedInput!]	Appointment type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`contactType`	[ContactTypeOrderByNestedInput!]	Contact type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`customEntityType`	[CustomEntityTypeOrderByNestedInput!]	Custom entity type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`leadType`	[LeadTypeOrderByNestedInput!]	Lead type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`opptyType`	[OpportunityTypeOrderByNestedInput!]	Opportunity type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`productType`	[ProductTypeOrderByNestedInput!]	Product type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`projectType`	[ProjectTypeOrderByNestedInput!]	Project type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`quoteType`	[QuoteTypeOrderByNestedInput!]	Quote type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`taskType`	[TaskTypeOrderByNestedInput!]	Task type the interface preview applies to. Sorts by fields of the related record, listed in order of priority.
`accountTypeId`	OrderByEnum	Id of the account type the interface preview applies to.
`appointmentTypeId`	OrderByEnum	Id of the appointment type the interface preview applies to.
`contactTypeId`	OrderByEnum	Id of the contact type the interface preview applies to.
`customEntityTypeId`	OrderByEnum	Id of the custom entity type the interface preview applies to.
`leadTypeId`	OrderByEnum	Id of the lead type the interface preview applies to.
`opptyTypeId`	OrderByEnum	Id of the opportunity type.
`productTypeId`	OrderByEnum	Id of the product type the interface preview applies to.
`projectTypeId`	OrderByEnum	Id of the project type the interface preview applies to.
`quoteTypeId`	OrderByEnum	Id of the quote type the interface preview applies to.
`taskTypeId`	OrderByEnum	Id of the task type the interface preview applies to.
`isPublished`	OrderByEnum	True when the interface preview is published; false while it exists only as an unpublished draft.
`revision`	OrderByEnum	Revision when entity was lastly changed.
`entityApiName`	OrderByEnum	For custom entities, the API name of the targeted custom entity. Empty when the preview targets a built-in entity (use entityType to identify it).

AggregationOperator enum Count, Average, Sum, Min, Max, RunningCount, RunningSum

Aggregation function applied to a field's values across the records of a group.

Value	Description
`Count`	Number of records.
`Average`	Average of the field values.
`Sum`	Total of the field values.
`Min`	Lowest field value.
`Max`	Highest field value.
`RunningCount`	Cumulative number of records, adding each group to the groups before it.
`RunningSum`	Cumulative total of the field values, adding each group to the groups before it.

ChartComparison object 7 fields: isEnabled, dateFieldId, period, …

Comparison series of a report chart, defined by a period, by years or by a history comparison date.

Field	Type	Description
`isEnabled`	Boolean!	Whether the chart shows a comparison series.
`dateFieldId`	UUID	Identifier of the date field used to define the comparison period.
`period`	PeriodOption	Period the comparison series covers.
`yearComparison`	ChartYearComparison	Years the chart is compared with when it is grouped by a date or date-time field; required in that case, and period and dateFieldId are then not used.
`relativeComparison`	Boolean!	When true, the comparison is shown relative to the current series (such as a difference or percentage) rather than as an independent series.
`historyComparisonDateId`	UUID	Identifier of the history comparison date the chart compares against, for history-based reports.
`seriesColor`	Int	Color of the comparison series, given as an RGB color code encoded as an integer.

ChartYearComparison object period: YearComparisonPeriodEnum!, customYear: [Int!]

Years a report chart is compared with: the previous year or a list of years.

Field	Type	Description
`period`	YearComparisonPeriodEnum!	Which years the chart compares against: the previous year (YearPrevious) or an explicit list of years (Custom).
`customYear`	[Int!]	Explicit list of years to compare, used when the period is Custom.

GroupOption enum Daily, Weekly, Monthly, Quarterly, Yearly, FirstLetter, … (10 values)

How the values of a field are grouped into buckets in a report, chart or list.

Value	Description
`Daily`	Dates are grouped by day.
`Weekly`	Dates are grouped by week.
`Monthly`	Dates are grouped by month.
`Quarterly`	Dates are grouped by quarter.
`Yearly`	Dates are grouped by year.
`FirstLetter`	Text is grouped by its first letter.
`Combinations`	Multi-value fields are grouped by the exact combination of selected values.
`Values`	Multi-value fields are grouped by each individual value, so a record appears under every value it has.
`AutoIntervals`	Numbers are grouped into equal-width intervals whose width is taken from the first entry of groupIntervals.
`ManualIntervals`	Numbers are grouped into the custom intervals listed in groupIntervals.

InterfaceDetailTab object kind: InterfaceDetailTabKind!, lookupFieldId: UUID, visible: Boolean!

Tab of a record's detail screen configured in an interface preview, and whether it is shown.

Field	Type	Description
`kind`	InterfaceDetailTabKind!	Which tab of the record's detail screen this entry configures.
`lookupFieldId`	UUID	Identifier of the lookup field whose records the tab lists. Set only for the Lookup and LookupRelated kinds, null for every other kind.
`visible`	Boolean!	Whether the tab is shown on the detail screen.

InterfaceDetailTabKind enum Detail, Projects, Leads, Opportunities, Products, Accounts, … (19 values)

Tab of a record's detail screen that an interface layout entry configures.

Value	Description
`Detail`	Form with the record's own fields.
`Projects`	Projects related to the record.
`Leads`	Leads related to the record.
`Opportunities`	Opportunities related to the record.
`Products`	Products related to the record, such as opportunity or quote line items.
`Accounts`	Accounts related to the record; on an account, its related accounts.
`Contacts`	Contacts related to the record.
`RelationGraph`	Graph of relationships between the record and other accounts and contacts.
`OrgChart`	Organization chart of the contacts in the account.
`BuyingCenter`	Contacts involved in the buying decision of the lead or opportunity, with their roles.
`Activities`	Tasks and appointments linked to the record.
`Feeds`	Feed of activities, emails and updates related to the record.
`Documents`	Documents attached to the record.
`Notes`	Notes written on the record.
`Lookup`	Records selected in one of this record's lookup fields; lookupFieldId identifies the field.
`LookupRelated`	Records of another entity whose lookup field points to this record; lookupFieldId identifies that field.
`Quotes`	Quotes related to the record.
`ProductPricing`	Customer-specific product prices of the account.
`AccountHierarchy`	Parent and child account hierarchy of the account.

InterfaceDetailWidget object kind: InterfaceDetailWidgetKind!, visible: Boolean!

Side-panel widget of a record's detail screen configured in an interface preview, and whether it is shown.

Field	Type	Description
`kind`	InterfaceDetailWidgetKind!	Which side-panel widget of the record's detail screen this entry configures.
`visible`	Boolean!	Whether the widget is shown on the detail screen.

InterfaceDetailWidgetKind enum Status, EntityHealth, EntityScoring, Social, Processes, EmailSequences, … (18 values)

Side-panel widget of a record's detail screen that an interface layout entry configures.

Value	Description
`Status`	Current status of the record.
`EntityHealth`	Health indicator of the account.
`EntityScoring`	Lead scoring result of the record.
`Social`	Social network profiles of the account or contact.
`Processes`	Automation processes related to the record.
`EmailSequences`	Email sequences the record is enrolled in.
`Hubspot`	Data from the HubSpot integration for the record.
`Owner`	Owner of the record.
`Sharing`	Users and sales units the record is shared with.
`Fitness`	Fitness indicators that flag issues with the lead or opportunity.
`Tags`	Tags assigned to the record.
`StepChecklist`	Checklist of the record's current pipeline step.
`RevenueSchedule`	Revenue schedule of the opportunity.
`Approval`	Approval status of the record.
`DuplicateChecker`	Possible duplicates of the record.
`StaticProfiles`	Static lists the record is included in.
`AiSummary`	AI-generated summary of the record.
`Zoominfo`	Company or contact data from the ZoomInfo integration.

InterfacePreviewChart object 6 fields: id, name, description, …

Chart or list shown in a record's preview pane, built from records of a related entity.

Field	Type	Description
`id`	UUID!	Identifier of the chart inside the preview configuration.
`name`	String	Chart name shown as its heading in the preview pane.
`description`	String	Longer explanation of what the chart shows.
`entityType`	EntityNameEnum!	Related entity the chart reads its records from, e.g. Activity or Contact.
`settings`	InterfacePreviewSettings	Chart configuration: either a report chart definition or a sorted-list definition.
`filter`	ProfileFilterTab	Filter narrowing the records the chart shows.

InterfacePreviewCustomSettings object isLayoutCustomizationEnabled: Boolean!

Customization settings of an interface preview, such as whether users may change its layout.

Field	Type	Description
`isLayoutCustomizationEnabled`	Boolean!	When true, users may customize the layout of this interface preview.

InterfacePreviewSettings union ReportChart | ListChart

Configuration of a preview pane chart: a report chart definition or a sorted list definition.

ListChart object sortBy: ID!, sortOrder: SortOrder!

Preview pane chart that lists a record's related records sorted by a field.

Field	Type	Description
`sortBy`	ID!	Identifier of the field the list is sorted by.
`sortOrder`	SortOrder!	Sort direction applied to sortBy: Asc or Desc.

ProfileFilterTab object 6 fields: isEnabled, filterMainBox, filterSiblingBoxes, …

Filter made of a main box on the record type and boxes on related records, combined with And, Or or a custom formula.

Field	Type	Description
`isEnabled`	Boolean!	Whether the filter is applied. When false, the filter conditions are ignored.
`filterMainBox`	MainFilterBox!	Primary group of filter conditions evaluated on the main record type.
`filterSiblingBoxes`	[FilterBox!]!	Additional groups of filter conditions evaluated on related record types.
`isCustom`	Boolean!	True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions.
`operator`	FilterGroupOperator!	How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula.
`formula`	String	Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom.

ReportChart object 25 fields: isEnabled, type, fieldId, …

Chart of a report, such as a column, line, pie, scorecard or Sankey chart, with its fields, grouping, segmentation and comparison.

Field	Type	Description
`isEnabled`	Boolean!	Whether a chart is shown for this report tab.
`type`	ReportChartType!	Visual type of the chart, such as Scorecard, Pie, Line, Column, Bar, Bubble, ScatterPlot or Sankey.
`fieldId`	UUID	Identifier of the field whose values are plotted; left empty when the chart counts records.
`boxId`	UUID	Identifier of the report box that the plotted field belongs to.
`operator`	AggregationOperator!	How the plotted field's values are aggregated, such as Count, Sum, Average, Min or Max.
`groupFieldId`	UUID	Identifier of the field used to group values along the chart's main axis.
`groupBoxId`	UUID	Identifier of the report box that the grouping field belongs to.
`groupOption`	GroupOption	How the grouping field's values are grouped, for example by month or by interval.
`segmentFieldId`	UUID	Identifier of the field used to split each group into separate series or segments.
`segmentBoxId`	UUID	Identifier of the report box that the segment field belongs to.
`segmentFieldEnabled`	Boolean	For bubble chart and scatter plot only
`segmentOption`	GroupOption	How the segment field's values are grouped, for example by month or by interval.
`showAverage`	Boolean	Whether an average line is drawn on the chart.
`showNotAvailableValues`	Boolean	Whether records with no value for the grouping or plotted field are shown as a not-available category.
`comparison`	ChartComparison	Comparison series shown alongside the main series, such as a previous period or previous year.
`sortValues`	SortOrder	Orders the slices of a single-series pie chart by value, ascending or descending; when not set, the slices keep the grouping order.
`showNegativeValues`	Boolean!	Whether negative values are displayed on the chart.
`height`	Int	Height of the chart in pixels.
`showPercentageValues`	Boolean!	Whether values are labelled as percentages of the total.
`showNumbers`	Boolean!	Whether numeric value labels are shown on the chart.
`historyComparisonDateIds`	[UUID]	Identifiers of the history comparison dates the chart plots, for history-based reports.
`groupByHistory`	Boolean	Whether the chart groups values by history comparison date rather than by a regular field.
`sankey`	ReportSankeyChart	Flow definition used when the chart type is Sankey, describing the start and end grouping of records.
`showAllDataLabels`	Boolean!	Whether a data label is shown for every data point rather than only selected ones.
`seriesColor`	Int	Color of the main series, given as an RGB color code encoded as an integer.

ReportChartType enum Scorecard, Pie, Line, MultiLine, Column, StackedColumn, … (12 values)

Visual type of a report chart.

Value	Description
`Scorecard`	Single aggregated number.
`Pie`	Pie chart of each group's share of the total.
`Line`	Single line across the grouping field.
`MultiLine`	One line per segment across the grouping field.
`Column`	Vertical bars, one per group.
`StackedColumn`	Vertical bars with segments stacked on top of each other.
`MultiColumn`	Vertical bars for each segment placed side by side.
`Bar`	Horizontal bars, one per group.
`StackedBar`	Horizontal bars with segments stacked end to end.
`Bubble`	Points plotted by two values, with a third value setting the bubble size.
`ScatterPlot`	Points plotted by two values.
`Sankey`	Flow diagram showing how records move between groups.

ReportSankeyChart object 8 fields: startDate, startGroupBoxId, startGroupFieldId, …

Settings of a Sankey chart that shows how records move between groups from a start date to an end date.

Field	Type	Description
`startDate`	UUID	Identifier of the history comparison date that defines the starting point of the flow.
`startGroupBoxId`	UUID	Identifier of the report box providing the field that records are grouped by at the start of the flow.
`startGroupFieldId`	UUID!	Identifier of the field that records are grouped by at the start of the flow.
`startGroupOption`	GroupOption	How the starting field's values are grouped, for example by month or by interval.
`endDate`	UUID	Identifier of the history comparison date that defines the end point of the flow.
`endGroupBoxId`	UUID	Identifier of the report box providing the field that records are grouped by at the end of the flow.
`endGroupFieldId`	UUID!	Identifier of the field that records are grouped by at the end of the flow.
`endGroupOption`	GroupOption	How the ending field's values are grouped, for example by month or by interval.

YearComparisonPeriodEnum enum YearPrevious, Custom

Years a chart's values are compared against.

Value	Description
`YearPrevious`	The previous year.
`Custom`	The explicit list of years set on the chart.