tracksSummary

Query

Summarizes tracks over a time range.

Response

Returns TracksSummary

Arguments

Name	Type	Description
`startTime`	`DateTimeOffset!`	Start time for the summary.
`endTime`	`DateTimeOffset!`	End time for the summary.
`tags` Deprecated	`FilterTagInput`	If provided, filter tracks based on their tags. Deprecated: Use `filter.tag` instead.
`filter`	`FilterTracksSummaryInput`	If provided, only summarize events matching the filter.
`bucket` Deprecated	`SummaryBucketSize`	If provided, return summary buckets of this size. Deprecated: Bucket by `tracksBucket.size` instead.
`bucketingStrategy`	`BucketingStrategy!`	How to bucket tracks. Defaults to `ACTIVE`. Default: `ACTIVE`
`tracksBucket`	`TracksSummaryBucketType`	If provided, group the summary buckets by the provided grouping types.

Example

query tracksSummary(
  $startTime: DateTimeOffset!,
  $endTime: DateTimeOffset!,
  $tags: FilterTagInput,
  $filter: FilterTracksSummaryInput,
  $bucket: SummaryBucketSize,
  $bucketingStrategy: BucketingStrategy!,
  $tracksBucket: TracksSummaryBucketType
) {
  tracksSummary(
    startTime: $startTime,
    endTime: $endTime,
    tags: $tags,
    filter: $filter,
    bucket: $bucket,
    bucketingStrategy: $bucketingStrategy,
    tracksBucket: $tracksBucket
  ) {
    total
    startedCount
    endedCount
    buckets {
      key {
        time
      }
      total
      startedCount
      endedCount
    }
    highestTotalBuckets {
      key {
        time
      }
      total
    }
  }
}

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

{
  "data": {
    "tracksSummary": {
      "total": 841,
      "startedCount": 487,
      "endedCount": 832,
      "buckets": [
        {
          "key": {
            "time": "2025-01-01T00:00:00.000Z"
          },
          "total": 539,
          "startedCount": 657,
          "endedCount": 229
        }
      ],
      "highestTotalBuckets": [
        {
          "key": {
            "time": "2025-01-01T00:00:00.000Z"
          },
          "total": 391
        }
      ]
    }
  }
}