View as Markdown

TimeSeries

Field	Type	Description
id	string	The ID associated with this time series. Use it with the labels to uniquely identify a time series. For workflow-backed time series, this maps back to one or more action IDs.
labels	repeated bitdrift.public.shared.workflows.v1.LabelPair	The labels associated with this time series.
data	repeated bitdrift.public.shared.workflows.v1.DataPoint	The data points in this time series.
aggregation_window	google.protobuf.Duration	The aggregation window used for this stream. When streaming data, this is only set on the first response for a given time series.
legend	optional bitdrift.public.shared.workflows.v1.Legend	The legend for this time series. This formatted string can be shown to explain what the time series represents. Note that this may not be set via all APIs.
title	optional string	A simple title for the time series. This is a more compact version of the legend that can be used when the legend is too verbose. Note that this may not be set via all APIs.
unique_devices	optional uint64	The unique devices count for the entire series based on the TrackUnique configuration.
aggregated_rollup	double	The aggregated rollup for the entire series. Its meaning depends on the type of series. - counter: The sum of all data points. - rate: The sum of all numerator data points / the sum of all denominator data points. - histogram: The quantile over the entire range.
cardinality_overflows	bitdrift.public.shared.workflows.v1.CardinalityOverflows	The total count of cardinality overflows for this time series that occurred during the query time period.

Example

JSON

{
  "aggregated_rollup": 1.0,
  "aggregation_window": "3600s",
  "cardinality_overflows": {
    "group_by_overflows": 1,
    "query_group_by_collapsed": false,
    "total_overflows": 42
  },
  "data": [
    {
      "rate_details": {
        "denominator_count": 42,
        "numerator_count": 42
      },
      "timestamp": "2024-01-15T09:30:00Z",
      "unique_devices": 1,
      "value": 1.0
    }
  ],
  "id": "abc-123-def",
  "labels": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "legend": {
    "title": "Legend title"
  },
  "title": "Time series title",
  "unique_devices": 1
}