OBJECT

NyansaGraphQLQuery

Entry point for queries of various data types

link GraphQL Schema definition

  • type NyansaGraphQLQuery {
  • # Query of access points with pagination
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # uuids: Specific uuids to retrieve
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # fromDate: Returns results updated after this time
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • accessPointList(
  • search: String,
  • uuids: [String!],
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • fromDate: Date,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): AccessPointList!
  • # Query of devices with pagination
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # uuids: Specific uuids to retrieve
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # fromDate: Returns results updated after this time
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • deviceList(
  • search: String,
  • uuids: [String!],
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • fromDate: Date,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): DeviceList!
  • # Query of servers with pagination
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # uuids: Specific uuids to retrieve
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # fromDate: Returns results updated after this time
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • serverList(
  • search: String,
  • uuids: [String!],
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • fromDate: Date,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): ServerList!
  • # Query of controllers with pagination
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # uuids: Specific uuids to retrieve
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # fromDate: Returns results updated after this time
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • controllerList(
  • search: String,
  • uuids: [String!],
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • fromDate: Date,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): ControllerList!
  • # Query of applications
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # uuids: Specific uuids to retrieve
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # aggWindow: Select an aggregation window
  • # locationFilter: Filter by locations of these names
  • # appFilter: Filters results by Attribute
  • applicationList(
  • search: String,
  • uuids: [String!],
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • aggWindow: AggregationWindow,
  • locationFilter: [String!],
  • appFilter: AppFilter
  • ): ApplicationList!
  • # Omni-search of entities with pagination
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # pageSize: Size of a page
  • # page: Page number to return
  • # locationFilter: Filter by locations of these names
  • omnisearchList(
  • search: String!,
  • pageSize: Int,
  • page: Int,
  • locationFilter: [String!]
  • ): NyansaEntityList!
  • # Query of locations with pagination
  • #
  • # Arguments
  • # names: Location to retrieve by names
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • locationList(
  • names: [String!],
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder
  • ): LocationList!
  • # Query of custom groups with pagination
  • #
  • # Arguments
  • # names: Custom group to retrieve by names
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # typeFilter: Filter custom groups by type
  • # locationFilter: Filter by locations of these names
  • customGroupList(
  • names: [String!],
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • typeFilter: CustomGroupType,
  • locationFilter: [String!]
  • ): CustomGroupList!
  • # Query of incidents V1
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # metricCategory: Filter on an incident metric category
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • # locationFilter: Filter by locations of these names
  • incidentList(
  • search: String,
  • metricCategory: MetricCategory,
  • fromDate: Date,
  • toDate: Date,
  • locationFilter: [String!]
  • ): [Incident!]!
  • # Query of device problems with pagination
  • #
  • # Arguments
  • # uuids: Specific uuids to retrieve
  • # metricCategory: Filter on an incident metric category
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # locationFilter: Filter by locations of these names
  • deviceProblemsList(
  • uuids: [String!],
  • metricCategory: MetricCategory,
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • locationFilter: [String!]
  • ): DeviceProblemsList!
  • # Query of affected client hours distribution
  • #
  • # Arguments
  • # metricCategory: Filter on an incident metric category
  • # metricIds: Filter on one or more incident metric IDs
  • # aggFields: Fields to aggregate on
  • # pageSize: Size of a page
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • affectedClientHoursDistribution(
  • metricCategory: MetricCategory,
  • metricIds: [String!],
  • aggFields: [String!],
  • pageSize: Int,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): AffectedClientHoursList!
  • # Query of global advisories
  • #
  • # Arguments
  • # sortBy: Field to sort results by
  • # sortOrder: Order to sort results by
  • # metricIds: Filter on one or more incident metric IDs
  • # fromDate: Returns results updated after this time
  • # locationFilter: Filter by locations of these names
  • globalAdvisoryList(
  • sortBy: String,
  • sortOrder: SortingOrder,
  • metricIds: [String!],
  • fromDate: Date,
  • locationFilter: [String!]
  • ): GlobalAdvisoryList!
  • # Querying client hours remediations with pagination
  • #
  • # Arguments
  • # metricCategory: Filter on an incident metric category
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Field to sort results by
  • # sortOrder: Order to sort results by
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • remediationList(
  • metricCategory: MetricCategory,
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): RemediationList!
  • # Query of baseline history
  • #
  • # Arguments
  • # metricName: Filter on a named incident metric
  • # metricId: Filter on an incident metric ID
  • # sortOrder: Order to sort results by
  • # usageLevel: Level of usage used to consider data by
  • # locationFilter: Filter by a single location of this name
  • # filter: Filters results by a filterable attribute and value
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • baselineStatsList(
  • metricName: Metric,
  • metricId: String,
  • sortOrder: SortingOrder,
  • usageLevel: UsageLevel,
  • locationFilter: String,
  • filter: Filter,
  • fromDate: Date,
  • toDate: Date
  • ): [BaselineStats!]!
  • # Query of usage history
  • #
  • # Arguments
  • # metricName: Filter on a named incident metric
  • # metricId: Filter on an incident metric ID
  • # sortOrder: Order to sort results by
  • # locationFilter: Filter by a single location of this name
  • # filter: Filters results by a filterable attribute and value
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • usageHistoryList(
  • metricName: Metric,
  • metricId: String,
  • sortOrder: SortingOrder,
  • locationFilter: String,
  • filter: Filter,
  • fromDate: Date,
  • toDate: Date
  • ): [UsageTsSample!]!
  • # Query of annotations with pagination
  • #
  • # Arguments
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortOrder: Order to sort results by
  • # annotationGroup: Filter on an annotation group
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • # locationFilter: Filter by locations of these names
  • # metricCategory: Filter on an incident metric category
  • # customGroupFilter: Filter by custom group of this name
  • # filters: Filters results with a boolean expression
  • # metricIds: Filter on one or more incident metric IDs
  • # usageLevel: Level of usage used to consider data by
  • annotationList(
  • pageSize: Int,
  • page: Int,
  • sortOrder: SortingOrder,
  • annotationGroup: AnnotationType,
  • fromDate: Date,
  • toDate: Date,
  • locationFilter: [String!],
  • metricCategory: MetricCategory,
  • customGroupFilter: String,
  • filters: FieldFilters,
  • metricIds: [String!],
  • usageLevel: UsageLevel
  • ): AnnotationList!
  • # Query of IoT outliers with pagination
  • #
  • # Arguments
  • # uuids: Specific uuids to retrieve
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # aggWindow: Select an aggregation window
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • iotOutlierList(
  • uuids: [String!],
  • fromDate: Date,
  • toDate: Date,
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • aggWindow: AggregationWindow,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): IoTOutlierList!
  • # Query of IoT devices stats
  • #
  • # Arguments
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # aggWindow: Select an aggregation window
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • iotDeviceStatsList(
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • aggWindow: AggregationWindow,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): IoTDeviceStatsList!
  • # Query of IoT groups stats
  • #
  • # Arguments
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # aggWindow: Select an aggregation window
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • iotGroupStatsList(
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • aggWindow: AggregationWindow,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): IoTGroupStatsList!
  • # Query of single IoT device stats
  • #
  • # Arguments
  • # uuid: Specific uuid to retrieve
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • # aggField: Field to aggregate stats on
  • # sliceByProtocol: Should protocols be included in slicing the
  • # stats
  • # sortBy: Field to sort results by
  • # sortOrder: Order to sort results by
  • # locationFilter: Filter by a single location of this name
  • iotSingleDeviceStats(
  • uuid: String!,
  • fromDate: Date,
  • toDate: Date,
  • aggField: IoTStatsAggField,
  • sliceByProtocol: Boolean,
  • sortBy: String,
  • sortOrder: SortingOrder,
  • locationFilter: String
  • ): IoTSingleStats!
  • # Query of single IoT group stats
  • #
  • # Arguments
  • # model: Specific model to retrieve
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • # aggField: Field to aggregate stats on
  • # sliceByProtocol: Should protocols be included in slicing the
  • # stats
  • # sortBy: Field to sort results by
  • # sortOrder: Order to sort results by
  • # locationFilter: Filter by a single location of this name
  • iotSingleGroupStats(
  • model: String!,
  • fromDate: Date,
  • toDate: Date,
  • aggField: IoTStatsAggField,
  • sliceByProtocol: Boolean,
  • sortBy: String,
  • sortOrder: SortingOrder,
  • locationFilter: String
  • ): IoTSingleStats!
  • # Query of IoT benchmarking stats comparisons
  • #
  • # Arguments
  • # model: Specific model to retrieve
  • # benchmark: Particular benchmark to retrieve for IoT
  • iotBenchmarkComparisons(
  • model: String!,
  • benchmark: IoTBenchmark
  • ): [IoTBenchmarkComparison!]!
  • # Query of top 100 urls with pagination
  • #
  • # Arguments
  • # fromDate: Returns results updated after this time
  • # toDate: Returns results updated before this time
  • # isInternal: Filters hosts by internal, external, or both
  • # locationFilter: Filter by locations of these names
  • # filters: Filters results with a boolean expression
  • topUrlList(
  • fromDate: Date,
  • toDate: Date,
  • isInternal: Boolean,
  • locationFilter: [String!],
  • filters: FieldFilters
  • ): TopUrlsList!
  • }

link Require by

This element is not required by anyone