Calculate totals

Calculates totals for a previously-executed query, referenced by its queryUuid. Re-runs the source query’s MetricQuery against the warehouse so totals are correct for every metric type (count distinct, average, ratio, etc.) — unlike client-side cell summation, which only works for sum/count. The requested kind selects which totals to compute.

POST /api/v2/projects/{projectUuid}/query/{queryUuid}/calculate-total

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "resolvedTimezone": "<string>",
    "usedParametersValues": {},
    "parameterReferences": [
      "<string>"
    ],
    "cacheMetadata": {
      "cacheHit": true,
      "preAggregate": {
        "hit": true,
        "reason": {
          "reason": "no_pre_aggregates_defined"
        },
        "name": "<string>"
      },
      "cacheKey": "<string>",
      "cacheExpiresAt": "2023-11-07T05:31:56Z",
      "cacheUpdatedTime": "2023-11-07T05:31:56Z"
    },
    "queryUuid": "<string>",
    "warnings": [
      {
        "message": "<string>",
        "tables": [
          "<string>"
        ],
        "fields": [
          "<string>"
        ]
      }
    ],
    "fields": {},
    "metricQuery": {
      "tableCalculations": [
        {
          "displayName": "<string>",
          "name": "<string>",
          "sql": "<string>",
          "format": {
            "round": 123,
            "currency": "<string>",
            "prefix": "<string>",
            "suffix": "<string>",
            "custom": "<string>"
          },
          "index": 123
        }
      ],
      "limit": 123,
      "sorts": [
        {
          "descending": true,
          "fieldId": "<string>",
          "pivotValues": [
            {
              "value": "<string>",
              "reference": "<string>"
            }
          ],
          "nullsFirst": true
        }
      ],
      "filters": {
        "tableCalculations": {
          "or": [
            {
              "id": "<string>",
              "target": {
                "fieldId": "<string>"
              },
              "includeNull": true,
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true,
              "caseSensitive": true
            }
          ],
          "id": "<string>"
        },
        "metrics": {
          "or": [
            {
              "id": "<string>",
              "target": {
                "fieldId": "<string>"
              },
              "includeNull": true,
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true,
              "caseSensitive": true
            }
          ],
          "id": "<string>"
        },
        "dimensions": {
          "or": [
            {
              "id": "<string>",
              "target": {
                "fieldId": "<string>"
              },
              "includeNull": true,
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true,
              "caseSensitive": true
            }
          ],
          "id": "<string>"
        }
      },
      "metrics": [
        "<string>"
      ],
      "dimensions": [
        "<string>"
      ],
      "exploreName": "<string>",
      "metadata": {
        "hasADateDimension": {
          "name": "<string>",
          "label": "<string>",
          "table": "<string>"
        }
      },
      "pivotDimensions": [
        "<string>"
      ],
      "timezone": "<string>",
      "dimensionOverrides": {},
      "metricOverrides": {},
      "customDimensions": [
        {
          "id": "<string>",
          "name": "<string>",
          "table": "<string>",
          "type": "bin",
          "dimensionId": "<string>",
          "binType": "fixed_number",
          "binNumber": 123
        }
      ],
      "additionalMetrics": [
        {
          "sql": "<string>",
          "table": "<string>",
          "name": "<string>",
          "label": "<string>",
          "description": "<string>",
          "hidden": true,
          "round": 123,
          "index": 123,
          "filters": [
            {
              "id": "<string>",
              "target": {
                "fieldRef": "<string>"
              },
              "includeNull": true,
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true,
              "caseSensitive": true
            }
          ],
          "baseDimensionName": "<string>",
          "uuid": "<string>",
          "percentile": 123,
          "distinctKeys": [
            "<string>"
          ],
          "formatOptions": {
            "round": 123,
            "currency": "<string>",
            "prefix": "<string>",
            "suffix": "<string>",
            "custom": "<string>"
          },
          "generationType": "periodOverPeriod",
          "baseMetricId": "<string>",
          "timeDimensionId": "<string>",
          "periodOffset": 123
        }
      ]
    }
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

projectUuid · string · required

queryUuid · string · required

The UUID of the previously-executed query to compute totals from

Body

application/json

kind · enum<string> · required

Kinds of totals derivable from an executed pivot query. Follow-up PRs will widen the union to enable the commented-out variants below.

Available options: columnTotal, rowTotal, columnSubtotal

invalidateCache · boolean

subtotalDimensions · string[]

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok