Execute metric query

Executes a metric query asynchronously against your data warehouse using dimensions, metrics, filters, and sorts

POST /api/v2/projects/{projectUuid}/query/metric-query

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "usedParametersValues": {},
    "parameterReferences": [
      "<string>"
    ],
    "cacheMetadata": {
      "cacheHit": true,
      "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>",
          "type": "number",
          "format": {
            "type": "default",
            "round": 123,
            "separator": "default",
            "currency": "<string>",
            "compact": "thousands",
            "prefix": "<string>",
            "suffix": "<string>",
            "timeInterval": "RAW",
            "custom": "<string>"
          },
          "index": 123
        }
      ],
      "limit": 123,
      "sorts": [
        {
          "descending": true,
          "fieldId": "<string>",
          "nullsFirst": true
        }
      ],
      "filters": {
        "tableCalculations": {
          "or": [
            {
              "operator": "isNull",
              "id": "<string>",
              "target": {
                "fieldId": "<string>"
              },
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true
            }
          ],
          "id": "<string>"
        },
        "metrics": {
          "or": [
            {
              "operator": "isNull",
              "id": "<string>",
              "target": {
                "fieldId": "<string>"
              },
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true
            }
          ],
          "id": "<string>"
        },
        "dimensions": {
          "or": [
            {
              "operator": "isNull",
              "id": "<string>",
              "target": {
                "fieldId": "<string>"
              },
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true
            }
          ],
          "id": "<string>"
        }
      },
      "metrics": [
        "<string>"
      ],
      "dimensions": [
        "<string>"
      ],
      "exploreName": "<string>",
      "periodOverPeriod": {
        "granularity": "RAW",
        "type": "previousPeriod",
        "field": {
          "table": "<string>",
          "name": "<string>"
        },
        "periodOffset": 123
      },
      "metadata": {
        "hasADateDimension": {
          "name": "<string>",
          "label": "<string>",
          "table": "<string>"
        }
      },
      "timezone": "<string>",
      "metricOverrides": {},
      "customDimensions": [
        {
          "id": "<string>",
          "name": "<string>",
          "table": "<string>",
          "type": "bin",
          "dimensionId": "<string>",
          "binType": "fixed_number",
          "binNumber": 123,
          "binWidth": 123,
          "customRange": [
            {
              "to": 123,
              "from": 123
            }
          ]
        }
      ],
      "additionalMetrics": [
        {
          "type": "percentile",
          "sql": "<string>",
          "table": "<string>",
          "name": "<string>",
          "label": "<string>",
          "description": "<string>",
          "hidden": true,
          "round": 123,
          "compact": "thousands",
          "format": "km",
          "index": 123,
          "filters": [
            {
              "operator": "isNull",
              "id": "<string>",
              "target": {
                "fieldRef": "<string>"
              },
              "values": [
                "<unknown>"
              ],
              "settings": "<unknown>",
              "disabled": true,
              "required": true
            }
          ],
          "baseDimensionName": "<string>",
          "uuid": "<string>",
          "percentile": 123,
          "formatOptions": {
            "type": "default",
            "round": 123,
            "separator": "default",
            "currency": "<string>",
            "compact": "thousands",
            "prefix": "<string>",
            "suffix": "<string>",
            "timeInterval": "RAW",
            "custom": "<string>"
          }
        }
      ]
    }
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

Body

application/json

query · object · required

Construct a type with the properties of T except for those in type K.

Show child attributes

parameters · object

Construct a type with a set of properties K of type T

Show child attributes

invalidateCache · boolean

context · enum<string>

Available options: dashboardView, autorefreshedDashboard, exploreView, filterAutocomplete, chartView, chartHistory, sqlChartView, sqlRunner, viewUnderlyingData, alert, scheduledDelivery, csvDownload, gsheets, scheduledGsheetsChart, scheduledGsheetsDashboard, scheduledChart, scheduledDashboard, calculateTotal, calculateSubtotal, embed, ai, mcp, api, cli, metricsExplorer

periodOverPeriod · object

Show child attributes

pivotConfiguration · object

Show child attributes

dateZoom · object

Show child attributes

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok