POST
/
api
/
v1
/
projects
/
{projectUuid}
/
metricsExplorer
/
{explore}
/
{metric}
/
runMetricTotal
{
  "results": {
    "metric": {
      "fieldType": "metric",
      "type": "percentile",
      "name": "<string>",
      "label": "<string>",
      "table": "<string>",
      "tableLabel": "<string>",
      "sql": "<string>",
      "description": "<string>",
      "source": {
        "content": "<string>",
        "highlight": {
          "end": {
            "character": 123,
            "line": 123
          },
          "start": {
            "character": 123,
            "line": 123
          }
        },
        "range": {
          "end": {
            "character": 123,
            "line": 123
          },
          "start": {
            "character": 123,
            "line": 123
          }
        },
        "path": "<string>"
      },
      "hidden": true,
      "compact": "thousands",
      "round": 123,
      "format": "km",
      "groupLabel": "<string>",
      "groups": [
        "<string>"
      ],
      "urls": [
        {
          "label": "<string>",
          "url": "<string>"
        }
      ],
      "index": 123,
      "tags": [
        "<string>"
      ],
      "showUnderlyingValues": [
        "<string>"
      ],
      "filters": [
        {
          "values": [
            "<any>"
          ],
          "operator": "isNull",
          "id": "<string>",
          "target": {
            "fieldRef": "<string>"
          },
          "settings": "<any>",
          "disabled": true,
          "required": true
        }
      ],
      "percentile": 123,
      "formatOptions": {
        "type": "default",
        "round": 123,
        "separator": "default",
        "currency": "<string>",
        "compact": "thousands",
        "prefix": "<string>",
        "suffix": "<string>",
        "timeInterval": "RAW",
        "custom": "<string>"
      },
      "dimensionReference": "<string>",
      "requiredAttributes": {},
      "defaultTimeDimension": {
        "interval": "RAW",
        "field": "<string>"
      },
      "spotlight": {
        "categories": [
          "<string>"
        ],
        "visibility": "show"
      },
      "compiledSql": "<string>",
      "tablesReferences": [
        "<string>"
      ],
      "tablesRequiredAttributes": {},
      "availableTimeDimensions": [
        {
          "fieldType": "dimension",
          "type": "date",
          "name": "<string>",
          "label": "<string>",
          "table": "<string>",
          "tableLabel": "<string>",
          "sql": "<string>",
          "description": "<string>",
          "source": {
            "content": "<string>",
            "highlight": {
              "end": {
                "character": 123,
                "line": 123
              },
              "start": {
                "character": 123,
                "line": 123
              }
            },
            "range": {
              "end": {
                "character": 123,
                "line": 123
              },
              "start": {
                "character": 123,
                "line": 123
              }
            },
            "path": "<string>"
          },
          "hidden": true,
          "compact": "thousands",
          "round": 123,
          "format": "km",
          "groupLabel": "<string>",
          "groups": [
            "<string>"
          ],
          "urls": [
            {
              "label": "<string>",
              "url": "<string>"
            }
          ],
          "index": 123,
          "tags": [
            "<string>"
          ],
          "group": "<string>",
          "requiredAttributes": {},
          "timeInterval": "RAW",
          "timeIntervalBaseDimensionName": "<string>",
          "isAdditionalDimension": true,
          "colors": {},
          "isIntervalBase": true,
          "compiledSql": "<string>",
          "tablesReferences": [
            "<string>"
          ],
          "tablesRequiredAttributes": {}
        }
      ],
      "timeDimension": {
        "interval": "RAW",
        "field": "<string>",
        "table": "<string>"
      }
    },
    "comparisonValue": 123,
    "value": 123
  },
  "status": "ok"
}

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

Response

200
application/json

Success

The response is of type object.