INPUT_OBJECT

TargetFilterInput

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

link GraphQL Schema definition

  • input TargetFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [TargetFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [TargetFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: TargetFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # What the target measures: revenue from opportunities won, or the number of leads
  • # qualified or created in the target period.
  • calculationType: TargetCalculationTypeEnumFilterInput
  • # Id of the target currency.
  • currencyId: EntityFilterStringField
  • # Free-text description shown alongside the target.
  • description: EntityFilterStringField
  • # When true, the target is currently being tracked; when false, the target is a
  • # draft or has been deactivated.
  • isActive: Boolean
  • # Name of the entity and its default text representation.
  • name: EntityFilterStringField
  • # Id of the owning user.
  • ownerId: EntityFilterStringField
  • # Id of the assignee user.
  • targetClientId: EntityFilterStringField
  • # Kind of target: a User target for targetClient, a group target that is split
  • # into or combines user targets, or a Simulated what-if target.
  • type: TargetTypeEnumFilterInput
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Target value the user committed to for the current period.
  • target: Float
  • # Start date of the target period, derived from periodType and periodYear.
  • virtualPeriodFrom: Date
  • # End date of the target period, derived from periodType and periodYear.
  • virtualPeriodTo: Date
  • # Whole days remaining until the target period ends, or zero once the period is
  • # past.
  • daysLeft: Int
  • # Progress state of the target: Draft until it is activated, then NotStarted
  • # before its period begins, InProgress while the period runs, and Finished once it
  • # is marked finished or the period has ended.
  • status: TargetStatusEnum
  • # Date the target was marked as finished. Empty until the target is closed.
  • finishedDate: Date
  • # Projected end-of-period value extrapolated from progress to date. Used to
  • # compare against the committed target.
  • estimatedTarget: Float
  • # Calendar year the target period belongs to (e.g. 2026).
  • periodYear: Int
  • # Whether the target period follows the calendar year (CalendarYear) or the
  • # space's financial year (FinancialYear). Combined with periodYear to determine
  • # virtualPeriodFrom / virtualPeriodTo.
  • periodType: TargetsPeriodTypeEnum
  • # True when this target is rolled up into a parent group target (e.g. a team-level
  • # target aggregating its members). Read-only.
  • hasParentGroupTarget: Boolean
  • # Length of the fragments the target period is split into: the whole year (Year),
  • # quarters (Quarter) or months (Month).
  • periodFragmentType: TargetsPeriodFragmentTypeEnum
  • # Zero-based position of the current fragment within the parent period (e.g.
  • # fragment index 2 for the 3rd month in a yearly target split into monthly
  • # fragments).
  • periodFragmentIndex: Int
  • # Currency the target value is expressed in. Required when calculationType is a
  • # currency-based metric. Matches records where a related record meets these
  • # conditions.
  • currency: CurrencyFilterInput
  • # User who owns the target. Matches records where a related record meets these
  • # conditions.
  • owner: ClientFilterInput
  • # User the target is set on (the assignee). Required for User-type targets; null
  • # for group targets. Matches records where a related record meets these
  • # conditions.
  • targetClient: ClientFilterInput
  • # User-level child targets that aggregate into this group target. Matches records
  • # where a related record meets these conditions.
  • childTargets: TargetRelationFilterInput
  • }