SearchDomain

SearchDomain is the common interface for repositories and views.

Table: SearchDomain

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Aug 21, 2025
`action(id: string): Action`	multiple	yes	`Long-Term`	A saved action. See Action.
`actions(actionIds: [string]): [Action]`	multiple	yes	`Long-Term`	A list of saved actions. See Action.
`aggregateAlert(id: string): AggregateAlert`	multiple	yes	`Long-Term`	A saved aggregate alert. See AggregateAlert.
`aggregateAlerts`	[`AggregateAlert`]	yes	`Long-Term`	A list of saved aggregate alerts. See AggregateAlert.
`alert(id: string): Alert`	multiple	yes	`Long-Term`	A saved alert. See Alert.
`alerts`	[`Alert`]	yes	`Long-Term`	Saved alerts. See Alert.
`allowedViewActions`	[`ViewAction`]	yes	`Long-Term`	Returns the all actions the user is allowed to perform on the view. See ViewAction.
`automaticSearch`	boolean	yes	`Long-Term`	Whether to execute automatically the default search query.
`availablePackages(filter: string, tags: [PackageTag], categories: [string]): [PackageRegistrySearchResultItem]`	multiple	yes	`Long-Term`	Returns a list of available packages that can be installed. PackageTag is a scalar. See PackageRegistrySearchResultItem.
`dashboard(id: string): Dashboard`	multiple	yes	`Long-Term`	The default or initial Dashboard to use. See Dashboard.
`dashboards`	[`Dashboard`]	yes	`Long-Term`	All dashboards available on the view. See Dashboard.
`defaultQuery`	`SavedQuery`		`Long-Term`	The default query used for the search domain when none is selected. See SavedQuery.
`deletedDate`	long		`Long-Term`	The point in time the search domain was marked for deletion.
`description`	string		`Long-Term`	A description of the search domain.
`fileFieldSearchfileFieldSearch(fileName: string, fieldName: string, prefixFilter: string, valueFilters: [FileFieldFilterType], fieldsToInclude: [string], maxEntries: integer): [[DictionaryEntryType]]`	multiple	yes	`Long-Term`	Used to search fields in a CSV or JSON file. See FileFieldFilterType and DictionaryEntryType.
`files`	[`File`]	yes	`Long-Term`	Files belonging to the search domain. See File.
`filterAlert(id: string): FilterAlert`	multiple	yes	`Long-Term`	A saved filter alert. See FilterAlert.
`filterAlerts`	[`FilterAlert`]	yes	`Long-Term`	Saved filter alerts. See FilterAlert.
`groups`	[`Group`]	yes	`Long-Term`	Groups with assigned roles. See Group.
`hasPackageInstalled(packageId: VersionedPackageSpecifier): boolean`	multiple	yes	`Long-Term`	Whether there is an installed package. VersionedPackageSpecifier is a scalar.
`id`	string	yes	`Long-Term`	The unique identifier for the search domain.
`installedPackages`	[`PackageInstallation`]	yes	`Long-Term`	List packages installed on a specific view or repository. See PackageInstallation.
`interactions`	[`ViewInteraction`]	yes	`Long-Term`	All interactions defined on the view. See ViewInteraction.
`isActionAllowed(action: ViewAction): boolean`	multiple	yes	`Long-Term`	Whether the current user is allowed to perform the action. See ViewAction.
`isStarred`	boolean	yes	`Long-Term`	Whether the search domain is highlighted with a star.
`name`	`RepoOrViewName`	yes	`Long-Term`	The name of the search domain. RepoOrViewName is a scalar.
`packageV2(packageId: VersionedPackageSpecifier): Package2`	multiple	yes	`Long-Term`	Returns a specific version of a package given a package version. VersionedPackageSpecifier is a scalar value. See Package2.
`packageVersions(packageId: UnversionedPackageSpecifier): [RegistryPackageVersionInfo]`	multiple	yes	`Long-Term`	The available versions of a package. UnversionedPackageSpecifier is a scalar. See RegistryPackageVersionInfo.
`permanentlyDeletedAt`	long		`Long-Term`	The point in time the search domain will not be restorable anymore.
`recentQueriesV2`	[`RecentQuery`]	yes	`Long-Term`	All recent queries for the search domain. See RecentQuery.
`reposExcludedInSearchLimit`	[string]	yes	`Long-Term`	Repositories not part of the search limitation.
`resource`	string	yes	`Short-Term`	The resource identifier for the search domain.
`savedQueries`	[`SavedQuery`]	yes	`Long-Term`	The saved queries. See SavedQuery.
`savedQuery(id: string): SavedQuery`	multiple	yes	`Long-Term`	A saved query. See SavedQuery.
`scheduledReport(id: string): ScheduledReport`	multiple	yes	`Long-Term`	A saved scheduled report. See ScheduledReport.
`scheduledReports`	[`ScheduledReport`]	yes	`Long-Term`	Saved scheduled reports. See ScheduledReport.
`scheduledSearch(id: string): ScheduledSearch`	multiple	yes	`Long-Term`	A saved scheduled search. See ScheduledSearch.
`scheduledSearches`	[`ScheduledSearch`]	yes	`Long-Term`	The scheduled searches to use with the search domain. See ScheduledSearch.
`searchLimitedMs`	long		`Long-Term`	Limit in milliseconds to which searches should are limited.
`starredFields`	[string]	yes	`Long-Term`	All fields in the search domain to mark with a star.
`tags`	[string]	yes	`Long-Term`	All tags from all datasources.
`users`	[`User`]	yes	`Long-Term`	Users who have access to the search domain. See User.
`usersandgroups(search: string, skip: integer, limit: integer): UsersAndGroupsSearchResultSet`	multiple		`Long-Term`	Users and groups associated with the search domain. See UsersAndGroupsSearchResultSet.
`usersV2(search: string, permissionFilter: Permission, skip: integer, limit: integer): Users`	multiple		`Short-Term`	Search users with a given permission, whose email or name matches this search string. See Permission and Users.
`viewerQueryPrefix`	string	yes	`Long-Term`	The query prefix prepended to each search in this domain.

GraphQL Datatypes

GraphQL API Stability

GraphQL Groups

GraphQL Queries

GraphQL Mutations

SearchDomain

Enter search term