eventsSummary

Query

Summarizes events over a time range.

Response

Returns EventsSummary

Arguments

Name	Type	Description
`startTime`	`DateTimeOffset!`	Start time for the summary.
`endTime`	`DateTimeOffset!`	End time for the summary.
`filter`	`FilterEventsSummaryInput`	If provided, only summarize events matching the filter.
`bucket` Deprecated	`SummaryBucketSize`	If provided, return summary buckets of this size. Deprecated: Grouping by `buckets` is deprecated in favor of grouping by `eventsBucket`. Use `eventsBucket.size` to group events by a `SummaryBucketSize`.
`bucketingStrategy`	`BucketingStrategy!`	How to bucket events. Defaults to `ACTIVE`. Default: `ACTIVE`
`eventsBucket`	`EventsSummaryBucketType`	If provided, group the summary buckets by the provided grouping types.
`metadataKeysPath`	`[String!]`	If provided, return metadata keys at this JSON path instead of root-level keys. Useful for drilling down into nested metadata objects.

Example

query eventsSummary(
  $startTime: DateTimeOffset!,
  $endTime: DateTimeOffset!,
  $filter: FilterEventsSummaryInput,
  $bucket: SummaryBucketSize,
  $bucketingStrategy: BucketingStrategy!,
  $eventsBucket: EventsSummaryBucketType,
  $metadataKeysPath: [String!]
) {
  eventsSummary(
    startTime: $startTime,
    endTime: $endTime,
    filter: $filter,
    bucket: $bucket,
    bucketingStrategy: $bucketingStrategy,
    eventsBucket: $eventsBucket,
    metadataKeysPath: $metadataKeysPath
  ) {
    total
    startedCount
    endedCount
    summaryStatistics {
      duration {
        min
        average
        max
      }
    }
    buckets {
      key {
        time
        type
        subType
        priority
        draft
        validationStatus
      }
      total
      startedCount
      endedCount
      summaryStatistics {
        __typename
      }
    }
    highestTotalBuckets {
      key {
        time
        type
        subType
        priority
        draft
        validationStatus
      }
      total
    }
    metadataKeys
  }
}

{
  "startTime": "2025-01-01T00:00:00.000Z",
  "endTime": "2025-01-01T00:00:00.000Z",
  "bucketingStrategy": "ACTIVE"
}

{
  "data": {
    "eventsSummary": {
      "total": 136,
      "startedCount": 678,
      "endedCount": 899,
      "summaryStatistics": {
        "duration": {
          "min": "PT1H",
          "average": "PT1H",
          "max": "PT1H"
        }
      },
      "buckets": [
        {
          "key": {
            "time": "2025-01-01T00:00:00.000Z",
            "type": "type-4c58",
            "subType": "subType-f45e",
            "priority": "priority-5ece",
            "draft": true,
            "validationStatus": "validationStatus-f85d"
          },
          "total": 623,
          "startedCount": 17,
          "endedCount": 985,
          "summaryStatistics": {
            "__typename": "EventsSummaryStatistics"
          }
        }
      ],
      "highestTotalBuckets": [
        {
          "key": {
            "time": "2025-01-01T00:00:00.000Z",
            "type": "type-4c58",
            "subType": "subType-f45e",
            "priority": "priority-5ece",
            "draft": true,
            "validationStatus": "validationStatus-f85d"
          },
          "total": 598
        }
      ],
      "metadataKeys": [
        "metadataKeys-d621"
      ]
    }
  }
}