Compile metric total query

Compile the metric total query SQL

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

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "parameterReferences": [
      "<string>"
    ],
    "query": "<string>",
    "compilationErrors": [
      "<string>"
    ],
    "pivotQuery": "<string>"
  }
}

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