OBJECT

InsightQuery

Insight queries

link GraphQL Schema definition

  • type InsightQuery {
  • # Query reclamation information for an entity
  • #
  • # Arguments
  • # entityId: [Not documented]
  • # input: [Not documented]
  • queryReclamationInfo(
  • entityId: EntityId!,
  • input: InsightReclamationInput
  • ): InsightReclamationInfo
  • insightRuleQuery: InsightRuleQuery!
  • # Query Observations
  • observationQuery: ObservationQuery!
  • # Query LeMans access key properties
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # accessKey: [Not documented]
  • queryAccessKeyProperty(accessKey: String!): InsightAccessKeyProperty!
  • # Query aggregated information on insights
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # filter: Optional additional field filters.
  • # insightQueryFilter: Specify query filter
  • queryAggregations(
  • aggregations: [InsightAggregationInput!]!,
  • filter: QueryFilter,
  • insightQueryFilter: InsightFilter!
  • ): InsightAggregations!
  • # Query entities by list of given Insight search criteria.
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # entityTypes: Entity Types of required entities in the format of
  • # Provider.Service.Type
  • # filter: Optional additional field filters.
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # insightFilter: Insight filter with required filter parameters
  • # sort: Sort order for results in InsightConnection
  • queryEntitiesByInsightsFilter(
  • after: String,
  • entityTypes: [String!],
  • filter: QueryFilter,
  • first: Int,
  • insightFilter: InsightFilter!,
  • sort: [QuerySort!]
  • ): EntityConnection
  • # Query an insight's changelog
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # before: Return records before the given cursor, as per GraphQL
  • # Relay spec
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # insightId: [Not documented]
  • # mostRecentFirst: [Not documented]
  • # timeRange: Filter responses to changes within a given time
  • # range
  • queryInsightChangelog(
  • after: String,
  • before: String,
  • first: Int,
  • insightId: String!,
  • mostRecentFirst: Boolean,
  • timeRange: InsightTimeRangeFilter
  • ): InsightChangeLogConnection!
  • # Query highlights for an user
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # activityTimeRange: Filter responses to changes within a given
  • # activity time range
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # before: Return records before the given cursor, as per GraphQL
  • # Relay spec
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # impactTimeRange: Filter responses to changes within a given
  • # impact time range
  • # mostRecentFirst: [Not documented]
  • # userId: [Not documented]
  • queryInsightHighlight(
  • activityTimeRange: InsightTimeRangeFilter,
  • after: String,
  • before: String,
  • first: Int,
  • impactTimeRange: InsightTimeRangeFilter,
  • mostRecentFirst: Boolean,
  • userId: String!
  • ): [InsightHighlight!]
  • # Query histogram of insights
  • #
  • # Arguments
  • # histogramParam: Histogram input parameter
  • queryInsightHistogram(
  • histogramParam: InsightHistogramInput!
  • ): [InsightHistogramResult!]
  • # Query recommended solutions for an insight
  • #
  • # Arguments
  • # insightId: [Not documented]
  • queryInsightSolutions(insightId: String!): [InsightSolution!]
  • # Query insights by list of given search criteria. If no filter provided default
  • # filter on startTime will be added
  • # to fetch insight from past 2 days.
  • # It is recommended to add time based filters for quicker response.
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # filter: "Optional additional field filters.
  • # If no filter provided default filter on startTime will be added to fetch insight
  • # from past 2 days."
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # insightFilter: Insight filter with required filter parameters
  • # sort: Sort order for results in InsightConnection
  • queryInsights(
  • after: String,
  • filter: QueryFilter,
  • first: Int,
  • insightFilter: InsightFilter!,
  • sort: [QuerySort!]
  • ): InsightConnection
  • # Query for specific Insights by insight Ids
  • #
  • # Arguments
  • # insightId: Array of insight id's to query
  • queryInsightsByIds(insightId: [String!]!): [Insight]
  • # Query tag occurrence per tenant
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # filter: [Not documented]
  • queryObservationTagOccurrence(
  • filter: QueryFilter
  • ): [ObservationTagOccurrence!]
  • # Query observation timeline for an insight
  • #
  • # Arguments
  • # timelineParam: Timeline input parameter
  • queryObservationTimeLineForInsight(
  • timelineParam: InsightTimelineInput!
  • ): InsightTimelineResult!
  • # Query observations history by insight id
  • #
  • # Arguments
  • # insightId: [Not documented]
  • queryObservationsHistory(insightId: String!): [ObservationHistory!]
  • }

link Require by