OBJECT

ObservationQuery

Observation queries

link GraphQL Schema definition

  • type ObservationQuery {
  • # Query aggregated information on observations
  • #
  • # **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.
  • # observationFilter: Specify query filter
  • queryAggregations(
  • aggregations: [ObservationAggregationInput!]!,
  • filter: QueryFilter,
  • observationFilter: ObservationFilter
  • ): ObservationAggregations!
  • # Query histogram of observations
  • #
  • # Arguments
  • # histogramParam: Histogram input parameter
  • queryObservationHistogram(
  • histogramParam: ObservationHistogramInput!
  • ): [ObservationHistogramResult!]
  • # Query metric meta data which triggered observation
  • #
  • # Arguments
  • # observationIds: Array of observation id to query
  • queryObservationMetricInfo(observationIds: [ID!]!): [ObservationMetricInfoResult!]
  • # Query details on observations group by observation name
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # trendParam: Trend input parameter
  • queryObservationTrend(
  • after: String,
  • first: Int,
  • trendParam: ObservationTrendInput!
  • ): ObservationTrendResult!
  • # Query observation trend details by observation name
  • #
  • # Arguments
  • # name: [Not documented]
  • queryObservationTrendByName(name: String!): ObservationTrendAnalysis
  • # Query usage history for a specific time range
  • #
  • # Arguments
  • # histogramParam: Histogram input parameter
  • queryObservationUsage(
  • histogramParam: ObservationUsageHistogramInput!
  • ): ObservationUsageResult!
  • # Query observations by list of given 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
  • # filter: Optional field filters
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # observationFilter: Observation filter with filter parameters
  • # sort: Sort order for results in ObservationConnection
  • queryObservations(
  • after: String,
  • filter: QueryFilter,
  • first: Int,
  • observationFilter: ObservationFilter,
  • sort: [QuerySort!]
  • ): ObservationConnection!
  • # get top N observation trends based on percentage changes
  • #
  • # Arguments
  • # topCount: [Not documented]
  • queryTopChangedObservationTrends(
  • topCount: Int!
  • ): [ObservationTrendSummary!]
  • }