Query ScheduledMetricCalculation
Query results from a given metric calculation schedule. This is a general endpoint for querying and aggregating metric data. The aggregation can be performed over both time and specific dimensions.
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": [
{}
]
}
'import requests
url = "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query"
payload = {
"groupByDimensions": ["<string>"],
"accumulateDimension": "<string>",
"timeZone": "<string>",
"startTime": {},
"endTime": {},
"includeAllCombinations": True,
"dimensionFilters": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groupByDimensions: ['<string>'],
accumulateDimension: '<string>',
timeZone: '<string>',
startTime: {},
endTime: {},
includeAllCombinations: true,
dimensionFilters: [{}]
})
};
fetch('https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groupByDimensions' => [
'<string>'
],
'accumulateDimension' => '<string>',
'timeZone' => '<string>',
'startTime' => [
],
'endTime' => [
],
'includeAllCombinations' => true,
'dimensionFilters' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query"
payload := strings.NewReader("{\n \"groupByDimensions\": [\n \"<string>\"\n ],\n \"accumulateDimension\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"startTime\": {},\n \"endTime\": {},\n \"includeAllCombinations\": true,\n \"dimensionFilters\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groupByDimensions\": [\n \"<string>\"\n ],\n \"accumulateDimension\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"startTime\": {},\n \"endTime\": {},\n \"includeAllCombinations\": true,\n \"dimensionFilters\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groupByDimensions\": [\n \"<string>\"\n ],\n \"accumulateDimension\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"startTime\": {},\n \"endTime\": {},\n \"includeAllCombinations\": true,\n \"dimensionFilters\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
magic dimensions exist for date, timestamp, hour (which is the start of the window) and group
Dimension to accumulate for (so each entry is the sum of the current entry plus the previous). Assumes that this dimension is sortable
The time zone that you want the results in.
Filter to remove any calculations that require data prior to this start time
Filter to remove any calculations that require data after this end time
If true, all combinations of observed dimension values will be included in the result, even if the summary statistic for that combination is zero.
Filters dimensions by included values.
Show child attributes
Show child attributes
Was this page helpful?
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": [
{}
]
}
'import requests
url = "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query"
payload = {
"groupByDimensions": ["<string>"],
"accumulateDimension": "<string>",
"timeZone": "<string>",
"startTime": {},
"endTime": {},
"includeAllCombinations": True,
"dimensionFilters": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groupByDimensions: ['<string>'],
accumulateDimension: '<string>',
timeZone: '<string>',
startTime: {},
endTime: {},
includeAllCombinations: true,
dimensionFilters: [{}]
})
};
fetch('https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groupByDimensions' => [
'<string>'
],
'accumulateDimension' => '<string>',
'timeZone' => '<string>',
'startTime' => [
],
'endTime' => [
],
'includeAllCombinations' => true,
'dimensionFilters' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query"
payload := strings.NewReader("{\n \"groupByDimensions\": [\n \"<string>\"\n ],\n \"accumulateDimension\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"startTime\": {},\n \"endTime\": {},\n \"includeAllCombinations\": true,\n \"dimensionFilters\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groupByDimensions\": [\n \"<string>\"\n ],\n \"accumulateDimension\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"startTime\": {},\n \"endTime\": {},\n \"includeAllCombinations\": true,\n \"dimensionFilters\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}:query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groupByDimensions\": [\n \"<string>\"\n ],\n \"accumulateDimension\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"startTime\": {},\n \"endTime\": {},\n \"includeAllCombinations\": true,\n \"dimensionFilters\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}
