Skip to main content

AggregateOutcomeResponse

Data returned for Aggregate Outcome. Required fields are entity, truncated, caps_fired, items, accuracy.

entityEntity (string)required

Terminal type of the definition

truncatedTruncated (boolean)required
caps_fired object[]required
  • Array [
    • op objectrequired
    anyOf
    integer
    capCap (string)required
    level objectrequired
    anyOf
    integer
  • ]
    • terminalTerminal (string)
    Constant value: aggregate
    Default value: aggregate
    itemsobject[]required

    One row per bucket (one row without group_by)

    accuracyAccuracy (string)required
    basis object

    Keys the aggregate was computed over

    anyOf
    integer
    AggregateOutcomeResponse
    {
      "entity": "string",
      "truncated": true,
      "caps_fired": [
        {
          "op": 0,
          "cap": "string",
          "level": 0
        }
      ],
      "terminal": "aggregate",
      "items": [
        {}
      ],
      "accuracy": "string",
      "basis": 0
    }