Skip to main content

AggregateArgs

limit returns the first limit buckets in group_by order (text in code-point order, NULL last) and marks the result truncated when more exist — the distinct values of a column, bounded. Without it a group_by past the binding's max_buckets is refused (too_many_buckets).

now object
anyOf
string<date-time>
metrics object[]required

Possible values: >= 1

  • Array [
    • fnFn (string)required

    Possible values: [count, count_distinct, sum, avg, min, max]

    column object

    Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

    anyOf
    string
  • ]
    • group_by object
    anyOf
  • Array [
    • string
  • ]
    • accuracyAccuracy (string)

    Possible values: [accurate, approximate]

    Default value: accurate
    limit object
    anyOf
    integer

    Possible values: >= 1

    AggregateArgs
    {
      "now": "2024-07-29T15:51:28.071Z",
      "metrics": [
        {
          "fn": "count",
          "column": "string"
        }
      ],
      "group_by": [
        "string"
      ],
      "accuracy": "accurate",
      "limit": 0
    }