Developers
ChangelogSupportcoevera.comGet API keys
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLTypes indexD

Types: D

View as Markdown/reference/graphql/types/d.mdOpen in ClaudeAsk Claude about this pageOpen in ChatGPTAsk ChatGPT about this page

Each type links to the repository page that documents it; the types several repositories share are documented below, with their fields.

A B C D E F G H I J L M N O P Q R S T U V W X Y

DashboardAgenda DashboardAgendaData DashboardAgendaPeriodEnum DashboardChart DashboardChartData DashboardChartError DashboardChartId DashboardChartSeries DashboardChartSeriesItem DashboardChartSeriesValueItem DashboardChartSeriesXYItem DashboardChartStep DashboardFilter DashboardGraphAccountNameType DashboardGraphActivityNameType DashboardGraphContactNameType DashboardGraphLeadNameType DashboardGraphOpportunityNameType DashboardGrid DashboardGridData DashboardInsights DashboardInsightsData DashboardInsightTile DashboardItem DashboardKpi DashboardKpiCustomDefinition DashboardKpiData DashboardKpiIndicatorEnum DashboardKpiList DashboardKpiListData DashboardKpiListItem DashboardListChartData DashboardListChartDataEntity DashboardOpportunitiesTrend DashboardOpportunitiesTrendData DashboardOpportunitiesTrendView DashboardPipelineConversionsChart DashboardPipelineConversionsChartData DashboardQuickLink DashboardQuickLinks DashboardReportChart DashboardReportChartData DashboardRole DashboardSchema DashboardSection DashboardTabItem DashboardTarget DashboardTargetData DashboardTargetTab DashboardTargetTypeEnum DashboardTile DashboardTileChangedRecords DashboardTileConditionalFormatting DashboardTileData DashboardViewInterface DataEntity DataEntityConnection DataEntityEdge DataFilterInput DataGridChange DataGridViewItem DataOrderByInput DataOrderByNestedInput DataRepository Date DateDayEnum DateDayEnumFilterInput DateDayOfWeekEnum DateDayOfWeekEnumFilterInput DateMonthEnum DateMonthEnumFilterInput DateTime DateWeekEnum DateWeekEnumFilterInput DefaultProfileEntity DeleteAccountInput DeleteAccountKPIInput DeleteAccountKPIPayload DeleteAccountPayload DeleteAccountProductPricingInput DeleteAccountProductPricingPayload DeleteAccountRelationInput DeleteAccountRelationLabelInput DeleteAccountRelationLabelPayload DeleteAccountRelationPayload DeleteAccountRelationTypeInput DeleteAccountRelationTypePayload DeleteAccountRoleInput DeleteAccountRolePayload DeleteAccountSharingClientRelationInput DeleteAccountSharingClientRelationPayload DeleteAccountSharingSalesUnitRelationInput DeleteAccountSharingSalesUnitRelationPayload DeleteAccountSocialRelationInput DeleteAccountSocialRelationPayload DeleteActivityCommentInput DeleteActivityCommentPayload DeleteActivityKPIInput DeleteActivityKPIPayload DeleteActivityRelationInput DeleteActivityRelationPayload DeleteAllowedAccountTypeInput DeleteAllowedAccountTypePayload DeleteAllowedAppointmentTypeInput DeleteAllowedAppointmentTypePayload DeleteAllowedCompanyEmailInput DeleteAllowedCompanyEmailPayload DeleteAllowedCompanyPhoneInput DeleteAllowedCompanyPhonePayload DeleteAllowedContactTypeInput DeleteAllowedContactTypePayload DeleteAllowedLeadTypeInput DeleteAllowedLeadTypePayload DeleteAllowedPipelineInput DeleteAllowedPipelinePayload DeleteAllowedQuoteTypeInput DeleteAllowedQuoteTypePayload DeleteAllowedTaskTypeInput DeleteAllowedTaskTypePayload DeleteAppointmentClientInviteesRelationInput DeleteAppointmentClientInviteesRelationPayload DeleteAppointmentContactInviteesRelationInput DeleteAppointmentContactInviteesRelationPayload DeleteAppointmentInput DeleteAppointmentPayload DeleteAppointmentReminderInput DeleteAppointmentReminderPayload DeleteAppointmentScheduleInput DeleteAppointmentSchedulePayload DeleteApprovalApproverInput DeleteApprovalApproverPayload DeleteApprovalInput DeleteApprovalPayload DeleteApprovalProcessActivityLogLineInput DeleteApprovalProcessActivityLogLinePayload DeleteApprovalProcessInput DeleteApprovalProcessPayload DeleteCallInput DeleteCallPayload DeleteChatConversationInput DeleteChatConversationPayload DeleteClientExcludedOpptyInput DeleteClientExcludedOpptyPayload DeleteClientFavoriteInput DeleteClientFavoritePayload DeleteClientInput DeleteClientPayload DeleteClientStoryReadInput DeleteClientStoryReadPayload DeleteCloudObjectFolderInput DeleteCloudObjectFolderPayload DeleteCloudObjectInput DeleteCloudObjectPayload DeleteCloudObjectRelationInput DeleteCloudObjectRelationPayload DeleteCloudObjectsInput DeleteCloudObjectsPayload DeleteCloudObjectStepRelationInput DeleteCloudObjectStepRelationPayload DeleteCloudObjectTemplateInput DeleteCloudObjectTemplatePayload DeleteContactAccountAccountRoleRelationInput DeleteContactAccountAccountRoleRelationPayload DeleteContactAccountRelationInput DeleteContactAccountRelationPayload DeleteContactInput DeleteContactKPIInput DeleteContactKPIPayload DeleteContactPayload DeleteContactRelationInput DeleteContactRelationLabelInput DeleteContactRelationLabelPayload DeleteContactRelationPayload DeleteContactRelationTypeInput DeleteContactRelationTypePayload DeleteContactSharingClientRelationInput DeleteContactSharingClientRelationPayload DeleteContactSharingSalesUnitRelationInput DeleteContactSharingSalesUnitRelationPayload DeleteContactSocialRelationInput DeleteContactSocialRelationPayload DeleteCountryCrmInput DeleteCountryCrmPayload DeleteCurrencyExchangeRateInput DeleteCurrencyExchangeRatePayload DeleteCurrencyExchangeRatesListInput DeleteCurrencyExchangeRatesListPayload DeleteCurrencyInput DeleteCurrencyPayload DeleteCustomEntityDataExRelationInput DeleteCustomEntityDataExRelationPayload DeleteCustomEntitySharingClientRelationInput DeleteCustomEntitySharingClientRelationPayload DeleteCustomEntitySharingSalesUnitRelationInput DeleteCustomEntitySharingSalesUnitRelationPayload DeleteDataInput DeleteDataPayload DeleteDraftFieldInput DeleteDraftTranslationInput DeleteEmailContentSharingClientRelationInput DeleteEmailContentSharingClientRelationPayload DeleteEmailContentSharingSalesUnitRelationInput DeleteEmailContentSharingSalesUnitRelationPayload DeleteEmailEventInput DeleteEmailEventPayload DeleteEmailInput DeleteEmailLabelInput DeleteEmailLabelPayload DeleteEmailLabelRelationInput DeleteEmailLabelRelationPayload DeleteEmailPayload DeleteEmailSequenceActivityLogInput DeleteEmailSequenceActivityLogLineInput DeleteEmailSequenceActivityLogLinePayload DeleteEmailSequenceActivityLogPayload DeleteEmailSequenceEnrolledInput DeleteEmailSequenceEnrolledPayload DeleteEmailSequenceInput DeleteEmailSequencePayload DeleteEmailTemplateFolderInput DeleteEmailTemplateFolderPayload DeleteEmailTemplateInput DeleteEmailTemplatePayload DeleteEmailTemplateSharingClientRelationInput DeleteEmailTemplateSharingClientRelationPayload DeleteEmailTemplateSharingSalesUnitRelationInput DeleteEmailTemplateSharingSalesUnitRelationPayload DeleteEmailThreadMailboxClientReadStateInput DeleteEmailThreadMailboxClientReadStatePayload DeleteEntityFitnessIndicatorInput DeleteEntityFitnessIndicatorPayload DeleteEntityScoringInput DeleteEntityScoringPayload DeleteFieldMappingInput DeleteFieldMappingPayload DeleteFieldPayload DeleteForecastInput DeleteForecastPayload DeleteFormViewInput DeleteFormViewPayload DeleteFormViewSharingClientRelationInput DeleteFormViewSharingClientRelationPayload DeleteFormViewSharingSalesUnitRelationInput DeleteFormViewSharingSalesUnitRelationPayload DeleteGhostContactAccountAccountRoleRelationInput DeleteGhostContactAccountAccountRoleRelationPayload DeleteGhostContactAccountRelationInput DeleteGhostContactAccountRelationPayload DeleteGhostContactInput DeleteGhostContactPayload DeleteGhostLeadOpptyContactRelationInput DeleteGhostLeadOpptyContactRelationPayload DeleteGhostLeadOpptyContactSalesRoleRelationInput DeleteGhostLeadOpptyContactSalesRoleRelationPayload DeleteImportMappingMaskInput DeleteImportMappingMaskPayload DeleteLeadInput DeleteLeadOpptyAccountRelationInput DeleteLeadOpptyAccountRelationPayload DeleteLeadOpptyContactGroupRelationInput DeleteLeadOpptyContactGroupRelationPayload DeleteLeadOpptyContactRelationInput DeleteLeadOpptyContactRelationPayload DeleteLeadOpptyContactSalesRoleRelationInput DeleteLeadOpptyContactSalesRoleRelationPayload DeleteLeadOpptyKPIInput DeleteLeadOpptyKPIPayload DeleteLeadOpptySharingClientRelationInput DeleteLeadOpptySharingClientRelationPayload DeleteLeadOpptySharingSalesUnitRelationInput DeleteLeadOpptySharingSalesUnitRelationPayload DeleteLeadOpptyStepCheckListRelationInput DeleteLeadOpptyStepCheckListRelationPayload DeleteLeadPayload DeleteLeadProcessInput DeleteLeadProcessPayload DeleteMasterRightInput DeleteMasterRightPayload DeleteMediaInput DeleteMediaPayload DeleteMemoCommentInput DeleteMemoCommentPayload DeleteMemoInput DeleteMemoPayload DeleteMessageRelationInput DeleteMessageRelationPayload DeleteMessageSharingClientRelationInput DeleteMessageSharingClientRelationPayload DeleteMessageSharingSalesUnitRelationInput DeleteMessageSharingSalesUnitRelationPayload DeleteMessagingPhonePayload DeleteNoteInput DeleteNotePayload DeleteOnlineFormActivityLogLineInput DeleteOnlineFormActivityLogLinePayload DeleteOnlineFormDataExRelationInput DeleteOnlineFormDataExRelationPayload DeleteOnlineFormInput DeleteOnlineFormPayload DeleteOnlineFormRelationInput DeleteOnlineFormRelationPayload DeleteOnlineFormStyleInput DeleteOnlineFormStylePayload DeleteOnlineFormTypeEmailRelationInput DeleteOnlineFormTypeEmailRelationPayload DeleteOnlineFormTypeInput DeleteOnlineFormTypePayload DeleteOpportunityInput DeleteOpportunityPayload DeleteOpptyProductRelationDataExRelationInput DeleteOpptyProductRelationDataExRelationPayload DeleteOpptyProductRelationInput DeleteOpptyProductRelationPayload DeleteOpptyRecurrenceInput DeleteOpptyRecurrencePayload DeleteParentAccountRelationTypeInput DeleteParentAccountRelationTypePayload DeletePhoneInput DeletePhonePayload DeletePipelineInput DeletePipelinePayload DeleteProcessActivityLogInput DeleteProcessActivityLogLineInput DeleteProcessActivityLogLinePayload DeleteProcessActivityLogPayload DeleteProcessInput DeleteProcessPayload DeleteProcessTemplateInput DeleteProcessTemplatePayload DeleteProductCategoryInput DeleteProductCategoryPayload DeleteProductInput DeleteProductPayload DeleteProductPipelineRelationInput DeleteProductPipelineRelationPayload DeleteProductPriceListInput DeleteProductPriceListPayload DeleteProductPriceListPriceInput DeleteProductPriceListPricePayload DeleteProfileRelationInput DeleteProfileRelationPayload DeleteProjectContactRelationInput DeleteProjectContactRelationPayload DeleteProjectInput DeleteProjectKPIInput DeleteProjectKPIPayload DeleteProjectObjectiveInput DeleteProjectPayload DeleteProjectSharingClientRelationInput DeleteProjectSharingClientRelationPayload DeleteProjectSharingSalesUnitRelationInput DeleteProjectSharingSalesUnitRelationPayload DeleteQuoteAccountRelationInput DeleteQuoteAccountRelationPayload DeleteQuoteContactRelationInput DeleteQuoteContactRelationPayload DeleteQuoteDataExRelationInput DeleteQuoteDataExRelationPayload DeleteQuoteInput DeleteQuoteKPIInput DeleteQuoteKPIPayload DeleteQuotePayload DeleteQuoteProcessInput DeleteQuoteProcessPayload DeleteQuoteSharingClientRelationInput DeleteQuoteSharingClientRelationPayload DeleteQuoteSharingSalesUnitRelationInput DeleteQuoteSharingSalesUnitRelationPayload DeleteReportScheduleInput DeleteReportSchedulePayload DeleteSalesRoleInput DeleteSalesRolePayload DeleteSalesUnitInput DeleteSalesUnitPayload DeleteSolutionInput DeleteSolutionPayload DeleteSolutionTemplateInput DeleteSolutionTemplatePayload DeleteStepChecklistInput DeleteStepChecklistPayload DeleteStepChecklistSalesRoleRelationInput DeleteStepChecklistSalesRoleRelationPayload DeleteStepInput DeleteTagInput DeleteTagPayload DeleteTagRelationInput DeleteTagRelationPayload DeleteTargetInput DeleteTargetPayload DeleteTargetRelationInput DeleteTargetRelationPayload DeleteTaskInput DeleteTaskPayload DeleteTaskRecurrenceInput DeleteTaskRecurrencePayload DeleteTaskReminderInput DeleteTaskReminderPayload DeleteTaskSharingClientRelationInput DeleteTaskSharingClientRelationPayload DeleteTaskSharingSalesUnitRelationInput DeleteTaskSharingSalesUnitRelationPayload DeleteTextMessageConversationRelationsInput DeleteTextMessageConversationRelationsPayload DeleteTranslationPayload DeleteUnsubscribedPhoneInput DeleteUnsubscribedPhonePayload DeleteWebhookEventInput DeleteWebhookEventPayload DeleteWebhookInput DeleteWebhookPayload DisableMessagingPhonePayload DisplayColumnParams DisplayFieldItem DisplayOption DisplayParamEnum DisplayParamEnumFilterInput DocumentPreviewUrl DrilldownFilterJSONString DropDownAutoselectEnum DueDateProperty

Shared types: D

Types several repositories use, or none does, with their fields and their descriptions.

DashboardAgendaData object id: String, error: DashboardChartError, agenda: BetterDashboardAgenda

Computed agenda of an agenda dashboard item.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
agendaBetterDashboardAgendaAgenda of the item: upcoming tasks, appointments and opportunities, and overdue tasks.
DashboardChartData union DashboardReportChartData | DashboardPipelineConversionsChartData | DashboardListChartData | DashboardTileData | DashboardInsightsData | DashboardAgendaData | DashboardTargetData | DashboardOpportunitiesTrendData | DashboardGridData | DashboardKpiData | DashboardKpiListData

Computed data of a dashboard item or of a chart on a record's preview pane; the variant matches the kind of item.

DashboardChartError enum Disabled, NotEnoughPermissions, Deleted, Unavailable

Reason a dashboard chart, tile, target or agenda returns no data.

ValueDescription
DisabledThe chart is turned off in the source report or forecast.
NotEnoughPermissionsThe user lacks access to the source report or to fields it uses.
DeletedThe source report or record no longer exists.
UnavailableThe data cannot be computed for the current configuration, for example an unsupported source or aggregation.
DashboardChartId interface id: String, error: DashboardChartError

Fields shared by all computed dashboard and preview chart data: the chart id and the reason the data could not be loaded.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
DashboardChartSeries object 5 fields: items, label, isAverage, …

One data series of a computed report chart, such as a segment, a comparison period or the average line.

FieldTypeDescription
items[DashboardChartSeriesItem!]!Data points of the series, in display order.
labelStringName of the series: the segment value for a segmented chart; null otherwise.
isAverageBooleanTrue for the series that draws the average line.
comparisonPeriodPeriodOptionPeriod of the comparison series; null for the other series.
historyComparisonDateIdUUIDHistory comparison date the series shows, for history-based reports.
DashboardChartSeriesItem union DashboardChartSeriesValueItem | DashboardChartSeriesXYItem

Data point of a report chart series: a labeled value, or a point with coordinates for bubble and scatter charts.

DashboardChartSeriesValueItem object label: String, value: Float

Data point of a chart: a label on the horizontal axis and its value.

FieldTypeDescription
labelStringLabel of the data point shown on the horizontal axis, such as a month or an owner name.
valueFloatValue of the data point shown on the vertical axis; null when there is no value, for example in some forecast series.
DashboardChartSeriesXYItem object x: Float!, y: Float!, r: Float

Item for bubble chart (x, y, r) and scatter plot (x, y)

FieldTypeDescription
xFloat!Value on the horizontal axis: the numeric value of the grouping field.
yFloat!Value on the vertical axis: the aggregated value.
rFloatBubble size for bubble charts; null for scatter plots.
DashboardChartStep object conversion: Float, label: String!, value: Float

Conversion data of one step of a sales pipeline in a pipeline conversions chart.

FieldTypeDescription
conversionFloatShare, in percent, of the opportunities (or of their value, for Sum) that reached the step and moved beyond it.
labelString!Name of the pipeline step.
valueFloatNumber of opportunities that reached the step, or their total value for Sum.
DashboardGraphAccountNameType enum TopOwnersByAccounts, CountOfAccountsBySalesUnit, CountOfAccountsByAccountClass, TopAccountIndustriesByWonValue, TopAccountIndustries, TopAccountsByWonOpportunities, … (9 values)

Predefined graph shown on the account dashboard.

ValueDescription
TopOwnersByAccountsThe five users owning the most accounts.
CountOfAccountsBySalesUnitPie chart of the number of accounts per sales unit.
CountOfAccountsByAccountClassPie chart of the number of accounts per account class.
TopAccountIndustriesByWonValueThe five industries with the highest won opportunity value.
TopAccountIndustriesThe five industries with the most accounts.
TopAccountsByWonOpportunitiesThe five accounts with the highest won opportunity value.
TopAccountsByLostOpportunitiesThe five accounts with the highest lost opportunity value.
TopAccountsByNumberOfContactsThe five accounts with the most related contacts.
TopAccountsByActivitiesThe five accounts with the most activities, split by activity type.
DashboardGraphActivityNameType enum ComparisonActivityTypes, TopOwnersByActivities, TopUnitsByActivities, ComparisonTaskStatus, ComparisonTaskDue

Predefined graph shown on the activity dashboard.

ValueDescription
ComparisonActivityTypesPie chart of the number of activities per activity type.
TopOwnersByActivitiesThe five users with the most activities, split by activity type.
TopUnitsByActivitiesThe five sales units with the most activities, split by activity type.
ComparisonTaskStatusPie chart of the number of tasks per status.
ComparisonTaskDuePie chart of uncompleted tasks split into without due date, on time and overdue.
DashboardGraphContactNameType enum TopOwnersByContacts, CountOfContactsBySalesUnit, TopContactsByWonOpportunities, TopContactsByLostOpportunities, TopContactsByActivities

Predefined graph shown on the contact dashboard.

ValueDescription
TopOwnersByContactsThe five users owning the most contacts.
CountOfContactsBySalesUnitPie chart of the number of contacts per sales unit.
TopContactsByWonOpportunitiesThe five contacts with the highest won opportunity value.
TopContactsByLostOpportunitiesThe five contacts with the highest lost opportunity value.
TopContactsByActivitiesThe five contacts with the most activities, split by activity type.
DashboardGraphLeadNameType enum CountOfLeadsByRanking, CountOfLeadsByAccountClass, CountOfOpenLeadsByFitness, CountOfOpenLeadsByLabel, LeadsDaysInQueue

Predefined graph shown on the lead dashboard.

ValueDescription
CountOfLeadsByRankingNumber of leads per ranking (1 to 5 stars).
CountOfLeadsByAccountClassNumber of leads per account class of their related accounts.
CountOfOpenLeadsByFitnessNumber of leads per fitness level.
CountOfOpenLeadsByLabelNumber of labeled leads per label.
LeadsDaysInQueueNumber of leads by time in queue: under 3 days, 3 to 7 days, 1 to 2 weeks, 2 to 4 weeks and over 4 weeks.
DashboardGraphOpportunityNameType enum WonVsGoal, RankedVsGoal, WeightedVsGoal, UnweightedVsGoal, BalancedVsGoal, ComparisonOpportunityStatus, … (27 values)

Predefined graph shown on the opportunity dashboard.

ValueDescription
WonVsGoalGauge of won opportunity value against the dashboard goal.
RankedVsGoalGauge of ranked opportunity value (value weighted by ranking) against the goal.
WeightedVsGoalGauge of weighted opportunity value (value weighted by step probability) against the goal.
UnweightedVsGoalGauge of full opportunity value against the goal.
BalancedVsGoalGauge of balanced opportunity value (value weighted by both probability and ranking) against the goal.
ComparisonOpportunityStatusPie chart of opportunity count and value by status (open, won, lost).
ComparisonAccountClassTotalValuePie chart of opportunity value by account class of the related accounts.
SumOfUpcomingClosingDatesColumns of open opportunity value for the nearest upcoming closing dates.
AccountClassOpportunitiesTotalValueStacked columns of non-lost opportunity value per pipeline step, split by account class.
AccountClassNumberOfOpportunitiesStacked columns of non-lost opportunity count per pipeline step, split by account class.
RatioOfRankedOpportunitiesStacked columns per pipeline step showing the share of non-lost opportunities in each ranking (1 to 5 stars).
CountOfRankedOpportunitiesStacked columns per pipeline step showing the number of non-lost opportunities in each ranking.
TotalValueOfRankedOpportunitiesStacked columns per pipeline step showing the value of non-lost opportunities in each ranking.
TopWonOpportunitiesThe five won opportunities with the highest value.
TopLostOpportunitiesThe five lost opportunities with the highest value.
LastWonOpportunitiesThe five most recently closed won opportunities.
LastLostOpportunitiesThe five most recently closed lost opportunities.
TopAccountsByWonOpportunitiesThe five accounts with the highest won opportunity value.
TopAccountsByLostOpportunitiesThe five accounts with the highest lost opportunity value.
TopAccountsByOpenOpportunitiesThe five accounts with the highest open opportunity value.
TopLostReasonsThe five most frequent reasons for losing opportunities, with their count and value.
PipelineOverviewFunnel of open and won opportunity count and value per pipeline step, with the lost value per step.
PipelineVelocityAverage time opportunities spend in each pipeline step compared with the step's planned duration, and the average age of won opportunities.
CountOfOverdueOpportunitiesOpen opportunities per pipeline step, split into overdue (closing date passed) and on time.
PipelineConversionAndDropOffRatesPer pipeline step, how many opportunities passed through the step and how many were won or lost from it.
WinRateByOpportunityValueWin rate of closed opportunities grouped by opportunity value.
CountOfOpenOpportunitiesByFitnessNumber of opportunities by fitness level.
DashboardGridData object id: String, error: DashboardChartError, listViewItems: GenericDrilldownDataGridViewItems!

Computed rows of a grid dashboard item.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
listViewItemsGenericDrilldownDataGridViewItems! (9 args)Rows of the grid item. Columns, sorting and the record limit default to the grid configuration and can be overridden by the arguments; the filter argument is not applied.
DashboardInsightsData object id: String, error: DashboardChartError, insights: [DashboardTileData!]!

Computed values of the tiles of an insights dashboard item.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
insights[DashboardTileData!]!Values of the insight tiles, in the order of the insights item.
DashboardKpiData object 8 fields: id, error, kpiId, …

Computed values of a dashboard KPI for the current and comparison periods, with its chart data.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
kpiIdUUIDId of the KPI in the dashboard schema.
kpiCurrentValueFloatKPI value for the current period.
kpiPreviousValueFloatKPI value for the comparison period; null or 0 when the KPI is not compared.
kpiChartData[DashboardChartSeriesValueItem!]Values of the KPI over the current period, for its chart; null for a KPI in a KPI list.
kpiChartTargetFloatGoal of the KPI target; null for a KPI in a KPI list.
kpiRelativeDifferenceFloatFor a KPI in a KPI list, the current value minus the comparison value prorated to the elapsed part of the current period (0 when today is outside it); null for a standalone KPI.
DashboardKpiListData object id: String, error: DashboardChartError, kpiList: [DashboardKpiData!]!

Computed values of the KPIs of a KPI list dashboard item.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
kpiList[DashboardKpiData!]!Values of the KPIs in the list, in list order.
DashboardListChartData object 5 fields: id, error, entities, …

Computed data of a list chart on a record's preview pane: the records listed, their sorting and the total count.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
entities[DashboardListChartDataEntity!]Records shown in the list; most list charts show at most five records.
sortFieldFieldDescriptorField the records are sorted by; null when no sorting is set.
totalIntTotal number of matching records, which can exceed the records listed; null for a list of linked records.
DashboardListChartDataEntity object 12 fields: account, contact, lead, …

One record shown in a dashboard list chart, in the field matching its kind.

FieldTypeDescription
accountAccountEntityThe list item when it is an account.
contactContactEntityThe list item when it is a contact.
leadLeadEntityThe list item when it is a lead.
opportunityOpportunityEntityThe list item when it is an opportunity.
noteNoteEntityThe list item when it is a note.
cloudObjectCloudObjectEntityThe list item when it is a file.
taskTaskEntityThe list item when it is a task.
appointmentAppointmentEntityThe list item when it is an appointment.
projectObjectiveDataProjectObjectiveDataThe list item when it is a project objective.
projectDataProjectDataThe list item when it is a project, with its objective progress.
quoteQuoteEntityThe list item when it is a quote.
customEntityCustomEntityEntityThe list item when it is a custom entity record.
DashboardOpportunitiesTrendData object 8 fields: id, error, opportunitiesTrendWeightedData, …

Computed series of an opportunities trend dashboard item, one per value type.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
opportunitiesTrendWeightedData[DashboardChartSeriesValueItem!]!Weighted value of open and won opportunities by closing date, one item per step of the chart period.
opportunitiesTrendUnweightedData[DashboardChartSeriesValueItem!]!Unweighted value of open and won opportunities by closing date, one item per step of the chart period.
opportunitiesTrendBalancedData[DashboardChartSeriesValueItem!]!Balanced value of open and won opportunities by closing date, one item per step of the chart period.
opportunitiesTrendWonData[DashboardChartSeriesValueItem!]!Value of won opportunities by closing date, one item per step of the chart period.
opportunitiesTrendRankedData[DashboardChartSeriesValueItem!]!Ranked value of open and won opportunities by closing date, one item per step of the chart period.
goalFloatGoal value of the item target; null when no target is set.
DashboardPipelineConversionsChartData object id: String, error: DashboardChartError, steps: [DashboardChartStep!]

Computed data of a pipeline conversions dashboard item: the conversion of each step of the pipeline.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
steps[DashboardChartStep!]Conversion of each step of the sales pipeline, in step order.
DashboardReportChartData object 9 fields: id, error, series, …

Computed data of a report chart: its series, or its scorecard or Sankey values, and the fields used.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
series[DashboardChartSeries!]Data series of the chart; null for Scorecard and Sankey charts.
scorecardScorecardDataValue and comparison of a Scorecard chart; null for other chart types.
sankeySankeyDataFlow data of a Sankey chart; null for other chart types.
fieldFieldDescriptorField whose values are aggregated; null when the chart counts records.
groupFieldFieldDescriptorField the values are grouped by along the main axis.
segmentFieldFieldDescriptorField that splits the groups into separate series; null without segmentation.
typeReportChartTypeType of the chart, such as Line, Column, Pie, Scorecard or Sankey.
DashboardTargetData object 6 fields: id, error, targetName, …

Computed data of a target dashboard item: the actual value and the goal it is compared with.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
targetNameStringName of the saved target or forecast the item measures against; null for an inline goal.
targetDescriptionStringDescription of the saved target or forecast; null for an inline goal.
targetValueFloatActual aggregated value of the source records.
targetGoalFloatGoal value the actual value is compared against.
DashboardTileData object 5 fields: id, error, tileId, …

Computed value of a dashboard tile and the color set by its conditional formatting.

FieldTypeDescription
idStringId of the chart the data belongs to on a record compact view; null for dashboard items, which are returned in the order of the dashboard items.
errorDashboardChartErrorReason the item has no data; null when the data loaded.
tileIdUUIDId of the tile in the dashboard schema.
tileValueFloatAggregated value of the tile.
tileColorIntColor set by the first matching conditional formatting rule, as a packed RGB integer; null when no rule matches.
DashboardViewInterface interface drilldownFields: [ID!]!

View settings shared by the record-type dashboards of a dashboard report, such as the fields listed when a graph value is drilled into.

FieldTypeDescription
drilldownFields[ID!]!Identifiers of the fields shown as columns when a dashboard graph value is drilled down into.
DataOrderByNestedInput input 9 fields: id, isDeleted, modified, …

Sorting by a field of the related Data record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
calcValueOrderByEnumNumeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option).
optionNameOrderByEnumName of the entity and its default text representation.
sortOrderOrderByEnumPosition of the option within its data set; lower values appear first.
isPublishedOrderByEnumTrue when the entity configuration is published; false while it exists only as an unpublished draft.
revisionOrderByEnumRevision when entity was lastly changed.
DataRepository object 7 fields: getById, getByIds, getAll, …

Read operations for Data records.

FieldTypeDescription
getByIdDataEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[DataEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[DataEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaDataEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getPublished[DataEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset.
getDrafts[DataEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
getDraftByIdDataEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
Date scalar scalar

The Date scalar type represents a Date value as specified by [iso8601](https://en.wikipedia.org/wiki/ISO_8601).

DateDayEnum enum Day1, Day2, Day3, Day4, Day5, Day6, … (31 values)

Day of the month (1 to 31) used by task and opportunity recurrence settings.

ValueDescription
Day1Day 1 of the month.
Day2Day 2 of the month.
Day3Day 3 of the month.
Day4Day 4 of the month.
Day5Day 5 of the month.
Day6Day 6 of the month.
Day7Day 7 of the month.
Day8Day 8 of the month.
Day9Day 9 of the month.
Day10Day 10 of the month.
Day11Day 11 of the month.
Day12Day 12 of the month.
Day13Day 13 of the month.
Day14Day 14 of the month.
Day15Day 15 of the month.
Day16Day 16 of the month.
Day17Day 17 of the month.
Day18Day 18 of the month.
Day19Day 19 of the month.
Day20Day 20 of the month.
Day21Day 21 of the month.
Day22Day 22 of the month.
Day23Day 23 of the month.
Day24Day 24 of the month.
Day25Day 25 of the month.
Day26Day 26 of the month.
Day27Day 27 of the month.
Day28Day 28 of the month.
Day29Day 29 of the month.
Day30Day 30 of the month.
Day31Day 31 of the month.
DateDayEnumFilterInput input eq: [DateDayEnum!], NOT: DateDayEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[DateDayEnum!]Matches any of the listed values.
NOTDateDayEnumFilterInputMatches values that do not meet this condition.
DateDayOfWeekEnum enum Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

Day of the week, used as a bit flag in recurrence settings so several days can be combined.

ValueDescription
SundaySunday.
MondayMonday.
TuesdayTuesday.
WednesdayWednesday.
ThursdayThursday.
FridayFriday.
SaturdaySaturday.
DateDayOfWeekEnumFilterInput input eq: [DateDayOfWeekEnum!], NOT: DateDayOfWeekEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[DateDayOfWeekEnum!]Matches any of the listed values.
NOTDateDayOfWeekEnumFilterInputMatches values that do not meet this condition.
DateMonthEnum enum Month1, Month2, Month3, Month4, Month5, Month6, … (12 values)

Month of the year (1 = January to 12 = December) used by yearly recurrence settings.

ValueDescription
Month1January.
Month2February.
Month3March.
Month4April.
Month5May.
Month6June.
Month7July.
Month8August.
Month9September.
Month10October.
Month11November.
Month12December.
DateMonthEnumFilterInput input eq: [DateMonthEnum!], NOT: DateMonthEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[DateMonthEnum!]Matches any of the listed values.
NOTDateMonthEnumFilterInputMatches values that do not meet this condition.
DateTime scalar scalar

The DateTime scalar type represents a DateTime value as specified by [iso8601](https://en.wikipedia.org/wiki/ISO_8601).

DateWeekEnum enum WeekLast, Week1, Week2, Week3, Week4

Week of the month in which a recurrence falls, combined with dayOfWeek (for example the second Tuesday).

ValueDescription
WeekLastThe last occurrence of the selected weekday in the month.
Week1The first occurrence of the selected weekday in the month.
Week2The second occurrence of the selected weekday in the month.
Week3The third occurrence of the selected weekday in the month.
Week4The fourth occurrence of the selected weekday in the month.
DateWeekEnumFilterInput input eq: [DateWeekEnum!], NOT: DateWeekEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[DateWeekEnum!]Matches any of the listed values.
NOTDateWeekEnumFilterInputMatches values that do not meet this condition.
DocumentPreviewUrl object url: String, error: String

PDF preview of an Office document, or the reason why it could not be produced.

FieldTypeDescription
urlStringDownload URL of the PDF preview; null when the preview could not be produced.
errorStringWhy the preview could not be produced; null on success.
DrilldownFilterJSONString scalar scalar

JSON value, sent and returned as a string.