INPUT_OBJECT

ReportFilterInput

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

link GraphQL Schema definition

  • input ReportFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [ReportFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [ReportFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: ReportFilterInput
  • # 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
  • # Public access token used in shareable report URLs. Empty when public sharing is
  • # not configured for the report.
  • accessLink: EntityFilterStringField
  • # Free-text description shown alongside the report.
  • description: EntityFilterStringField
  • # Name of the entity and its default text representation.
  • name: EntityFilterStringField
  • # Id of the owning user.
  • ownerId: EntityFilterStringField
  • # Id of the parent report folder.
  • reportsFolderId: EntityFilterStringField
  • # Who besides the owner can access the report: nobody (Private, the default), the
  • # users and sales units in sharingClients and sharingUnits (Standard), or all
  • # users (AllView to view, AllEdit to also edit).
  • shareMode: ShareModeEnumFilterInput
  • # Legacy additional sharing options; kept with the record but no longer applied.
  • shareModeParams: ShareModeParamsEnumFilterInput
  • # When true, name and settings are kept in sync with the linked screen profile;
  • # when false, the report is detached from profile sync.
  • syncEnabled: Boolean
  • # Id of the synchronized record.
  • syncEntityId: EntityFilterStringField
  • # Kind of report: a table or pivot report, a dashboard, an opportunity forecast,
  • # or an advanced report built from several linked tables.
  • type: ReportTypeEnumFilterInput
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # User who owns the report or dashboard. Matches records where a related record
  • # meets these conditions.
  • owner: ClientFilterInput
  • # Report folder this report is filed under (default folder when empty). Matches
  • # records where a related record meets these conditions.
  • reportsFolder: ReportFolderFilterInput
  • # Specific record this report is synchronized to. Set only when syncEnabled is
  • # true. Matches records where a related record meets these conditions.
  • syncEntity: ProfileFilterInput
  • # The calling user's scheduled email delivery of this report; empty when none is
  • # set. Set it with `setScheduleReport` and remove it with `removeScheduleReport`.
  • # Matches records where a related record meets these conditions.
  • schedule: ReportScheduleFilterInput
  • # Sales units granted shared access to this report (custom share mode). Matches
  • # records where a related record meets these conditions.
  • sharingUnits: ReportSharingSalesUnitRelationFilterInput
  • # Users granted shared access to this report (custom share mode). Matches records
  • # where a related record meets these conditions.
  • sharingClients: ReportSharingClientRelationFilterInput
  • }