Skip to main content
POST
/
v1
/
scheduledMetricCalculations
/
{scheduledMetricCalculation}
:query
Query ScheduledMetricCalculation
curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupByDimensions": [
    "<string>"
  ],
  "accumulateDimension": "<string>",
  "timeZone": "<string>",
  "startTime": {},
  "endTime": {},
  "includeAllCombinations": true,
  "dimensionFilters": [
    {}
  ]
}
'
{
  "dimensions": [
    "<string>"
  ],
  "rows": [
    {
      "dimensions": [
        {}
      ],
      "value": {
        "averageSummaryStats": {
          "sum": 123,
          "sumOfSquares": 123,
          "count": 123,
          "countMissing": 123,
          "countMissingRows": 123,
          "mean": 123,
          "variance": 123,
          "varianceReductionStats": {
            "count": 123,
            "countMissing": 123,
            "countMissingRows": 123,
            "sum": 123,
            "postSum": 123,
            "postCount": 123,
            "sumOfSquares": 123,
            "sumOfProducts": 123,
            "mean": 123,
            "variance": 123,
            "covariance": 123
          }
        },
        "ratioSummaryStats": {
          "numeratorSum": 123,
          "numeratorSumOfSquares": 123,
          "denominatorSum": 123,
          "denominatorSumOfSquares": 123,
          "sumOfProducts": 123,
          "count": 123,
          "countMissing": 123,
          "countMissingRows": 123,
          "numeratorMean": 123,
          "numeratorVariance": 123,
          "denominatorMean": 123,
          "denominatorVariance": 123,
          "numeratorDenominatorCovariance": 123,
          "varianceReductionStats": {
            "count": 123,
            "countMissing": 123,
            "countMissingRows": 123,
            "numeratorSum": 123,
            "postNumeratorSum": 123,
            "numeratorSumOfSquares": 123,
            "denominatorSum": 123,
            "postDenominatorSum": 123,
            "denominatorSumOfSquares": 123,
            "sumOfProducts": 123,
            "numeratorNumeratorSumOfProducts": 123,
            "numeratorDenominatorSumOfProducts": 123,
            "denominatorNumeratorSumOfProducts": 123,
            "denominatorDenominatorSumOfProducts": 123,
            "numeratorMean": 123,
            "numeratorVariance": 123,
            "denominatorMean": 123,
            "denominatorVariance": 123,
            "numeratorDenominatorCovariance": 123,
            "preNumeratorPostNumeratorCovariance": 123,
            "preNumeratorPostDenominatorCovariance": 123,
            "preDenominatorPostNumeratorCovariance": 123,
            "preDenominatorPostDenominatorCovariance": 123
          }
        }
      },
      "aggCount": {}
    }
  ],
  "minStartTime": {},
  "maxStartTime": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
scheduledMetricCalculation
string
required

Body

application/json
​
groupByDimensions
string[]

magic dimensions exist for date, timestamp, hour (which is the start of the window) and group

​
accumulateDimension
string

Dimension to accumulate for (so each entry is the sum of the current entry plus the previous). Assumes that this dimension is sortable

​
timeZone
string

The time zone that you want the results in.

​
startTime
object

Filter to remove any calculations that require data prior to this start time

​
endTime
object

Filter to remove any calculations that require data after this end time

​
includeAllCombinations
boolean

If true, all combinations of observed dimension values will be included in the result, even if the summary statistic for that combination is zero.

​
dimensionFilters
object[]

Filters dimensions by included values.

Response

200 - application/json

OK

​
dimensions
string[]

The set of dimension names that will be available on all rows.

​
rows
object[]

The result data.

​
minStartTime
object

The smallest start time in the queried range.

​
maxStartTime
object

The largest start time in the queried range.