Run metric total query

Run a metric total query with comparison

POST /api/v1/projects/{projectUuid}/metricsExplorer/{explore}/{metric}/runMetricTotal

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "metric": {
      "fieldType": "metric",
      "name": "<string>",
      "label": "<string>",
      "table": "<string>",
      "tableLabel": "<string>",
      "sql": "<string>",
      "hidden": true,
      "compiledSql": "<string>",
      "description": "<string>",
      "source": {
        "content": "<string>",
        "range": {
          "end": {
            "character": 123,
            "line": 123
          },
          "start": {
            "character": 123,
            "line": 123
          }
        },
        "path": "<string>",
        "highlight": {
          "end": {
            "character": 123,
            "line": 123
          },
          "start": {
            "character": 123,
            "line": 123
          }
        }
      },
      "round": 123,
      "groupLabel": "<string>",
      "groups": [
        "<string>"
      ],
      "urls": [
        {
          "label": "<string>",
          "url": "<string>"
        }
      ],
      "index": 123,
      "tags": [
        "<string>"
      ],
      "parameterReferences": [
        "<string>"
      ],
      "showUnderlyingValues": [
        "<string>"
      ],
      "filters": [
        {
          "id": "<string>",
          "target": {
            "fieldRef": "<string>"
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true
        }
      ],
      "percentile": 123,
      "distinctKeys": [
        "<string>"
      ],
      "formatOptions": {
        "round": 123,
        "currency": "<string>",
        "prefix": "<string>",
        "suffix": "<string>",
        "custom": "<string>"
      },
      "dimensionReference": "<string>",
      "requiredAttributes": {},
      "anyAttributes": {},
      "defaultTimeDimension": {
        "field": "<string>"
      },
      "spotlight": {
        "owner": "<string>",
        "defaultFilter": {
          "id": "<string>",
          "target": {
            "fieldRef": "<string>"
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true
        },
        "defaultSegment": "<string>",
        "segmentBy": [
          "<string>"
        ],
        "filterBy": [
          "<string>"
        ],
        "categories": [
          "<string>"
        ]
      },
      "drivers": [
        "<string>"
      ],
      "aiHint": "<string>",
      "richText": "<string>",
      "compiledRelativeDateFilters": [
        {
          "compiledSql": "<string>",
          "fieldId": "<string>",
          "id": "<string>"
        }
      ],
      "compiledDistinctKeys": [
        "<string>"
      ],
      "compiledValueSql": "<string>",
      "compilationError": {
        "message": "<string>"
      },
      "tablesAnyAttributes": {},
      "tablesRequiredAttributes": {},
      "tablesReferences": [
        "<string>"
      ],
      "availableTimeDimensions": [
        {
          "fieldType": "dimension",
          "type": "date",
          "name": "<string>",
          "label": "<string>",
          "table": "<string>",
          "tableLabel": "<string>",
          "sql": "<string>",
          "hidden": true,
          "compiledSql": "<string>",
          "description": "<string>",
          "source": {
            "content": "<string>",
            "range": {
              "end": {
                "character": 123,
                "line": 123
              },
              "start": {
                "character": 123,
                "line": 123
              }
            },
            "path": "<string>",
            "highlight": {
              "end": {
                "character": 123,
                "line": 123
              },
              "start": {
                "character": 123,
                "line": 123
              }
            }
          },
          "round": 123,
          "groupLabel": "<string>",
          "groups": [
            "<string>"
          ],
          "urls": [
            {
              "label": "<string>",
              "url": "<string>"
            }
          ],
          "index": 123,
          "tags": [
            "<string>"
          ],
          "parameterReferences": [
            "<string>"
          ],
          "group": "<string>",
          "requiredAttributes": {},
          "anyAttributes": {},
          "timeIntervalLabel": "<string>",
          "timeIntervalBaseDimensionName": "<string>",
          "customTimeInterval": "<string>",
          "isAdditionalDimension": true,
          "skipTimezoneConversion": true,
          "colors": {},
          "isIntervalBase": true,
          "aiHint": "<string>",
          "formatOptions": {
            "round": 123,
            "currency": "<string>",
            "prefix": "<string>",
            "suffix": "<string>",
            "custom": "<string>"
          },
          "caseSensitive": true,
          "image": {
            "url": "<string>",
            "fit": "<string>",
            "height": 123,
            "width": 123
          },
          "richText": "<string>",
          "filterAutocomplete": {
            "fetchFromWarehouse": true,
            "labelDimension": "<string>",
            "values": [
              {
                "value": "<string>",
                "label": "<string>"
              }
            ]
          },
          "spotlight": {
            "segmentBy": true,
            "filterBy": true
          },
          "compiledRelativeDateFilters": [
            {
              "compiledSql": "<string>",
              "fieldId": "<string>",
              "id": "<string>"
            }
          ],
          "compiledDistinctKeys": [
            "<string>"
          ],
          "compiledValueSql": "<string>",
          "compilationError": {
            "message": "<string>"
          },
          "tablesAnyAttributes": {},
          "tablesRequiredAttributes": {},
          "tablesReferences": [
            "<string>"
          ]
        }
      ],
      "timeDimension": {
        "field": "<string>",
        "table": "<string>"
      }
    },
    "comparisonValue": 123,
    "value": 123
  },
  "status": "ok"
}

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

Path Parameters

projectUuid · string · required

explore · string · required

metric · string · required

Query Parameters

timeFrame · enum<string> · required

Available options: RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM

granularity · enum<string> · required

Available options: RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM

startDate · string · required

endDate · string · required

Body

application/json

rollingDays · number<double>

comparisonType · enum<string>

Available options: none, previous_period, rolling_days

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok