OBJECT
PeriodOption
Time period used by reports, dashboards and targets: a predefined range such as the current month, or a custom date range.
link GraphQL Schema definition
- type PeriodOption {
- # Set only if period set to Custom
- : Date
- # Set only if period set to Custom
- : Date
- # Time range the data is reported over (for example MonthCurrent, QuarterCurrent,
- # Custom). When Custom, periodCustomFrom and periodCustomTo define the bounds.
- : PeriodKind!
- }
link Require by
- ChartComparisonComparison series of a report chart, defined by a period, by years or by a history comparison date.
- DashboardChartSeriesOne data series of a computed report chart, such as a segment, a comparison period or the average line.
- DashboardKpiDashboard KPI item: a predefined or custom metric over a period, measured against a goal and optionally compared with an earlier period.
- DashboardOpportunitiesTrendViewDisplay settings of an opportunities trend dashboard item: the value series plotted, the period and its granularity.
- FeedEmailPreviewFilterTabFilter of the email feed: limits the emails shown by attachment, sender and period.
- FeedPreviewFilterTabFilter of a record's feed that narrows the messages shown by attachment, favorite flag, sender and period.
- OpportunityReportTargetTabTarget shown in lead and opportunity reports and dashboards: the goal, the field summed toward it, the period it is measured over and the period it is compared with.
- ReportHistoricalTrendHistoryHistory settings that plot the values of tracked fields as a trend over a period.
- ScorecardDataComputed value of a scorecard chart, with the value of the comparison period when one is set.
- TargetTabInterfaceTarget settings of a saved profile: the field summed toward the goal and the period it is measured over.