API Reference
Validate Metric
Validates a metric configuration
POST
/
v1
/
metrics:validateMetric
Validate Metric
curl --request POST \
--url https://metrics.eu.confidence.dev/v1/metrics:validateMetric \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metric": {
"displayName": "<string>",
"entity": "<string>",
"factTable": "<string>",
"typeSpec": {},
"createTime": {},
"updateTime": {},
"creator": "<string>",
"updater": "<string>",
"name": "<string>",
"description": "<string>",
"aggregationWindow": {},
"exposureOffset": {},
"measurementConfig": {
"openWindow": {}
},
"varianceReductionConfig": {
"disabled": true,
"aggregationWindowOverride": {}
},
"nullHandling": {
"replaceMeasureNullWithZero": true,
"replaceEntityNullWithZero": true
},
"defaultEffectSize": {
"value": "<string>"
},
"filterString": "<string>",
"deleteTime": {},
"labels": [
{}
],
"systemCreated": true,
"owner": "<string>",
"etag": "<string>",
"measurement": "<string>"
}
}
'import requests
url = "https://metrics.eu.confidence.dev/v1/metrics:validateMetric"
payload = { "metric": {
"displayName": "<string>",
"entity": "<string>",
"factTable": "<string>",
"typeSpec": {},
"createTime": {},
"updateTime": {},
"creator": "<string>",
"updater": "<string>",
"name": "<string>",
"description": "<string>",
"aggregationWindow": {},
"exposureOffset": {},
"measurementConfig": { "openWindow": {} },
"varianceReductionConfig": {
"disabled": True,
"aggregationWindowOverride": {}
},
"nullHandling": {
"replaceMeasureNullWithZero": True,
"replaceEntityNullWithZero": True
},
"defaultEffectSize": { "value": "<string>" },
"filterString": "<string>",
"deleteTime": {},
"labels": [{}],
"systemCreated": True,
"owner": "<string>",
"etag": "<string>",
"measurement": "<string>"
} }
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({
metric: {
displayName: '<string>',
entity: '<string>',
factTable: '<string>',
typeSpec: {},
createTime: {},
updateTime: {},
creator: '<string>',
updater: '<string>',
name: '<string>',
description: '<string>',
aggregationWindow: {},
exposureOffset: {},
measurementConfig: {openWindow: {}},
varianceReductionConfig: {disabled: true, aggregationWindowOverride: {}},
nullHandling: {replaceMeasureNullWithZero: true, replaceEntityNullWithZero: true},
defaultEffectSize: {value: '<string>'},
filterString: '<string>',
deleteTime: {},
labels: [{}],
systemCreated: true,
owner: '<string>',
etag: '<string>',
measurement: '<string>'
}
})
};
fetch('https://metrics.eu.confidence.dev/v1/metrics:validateMetric', 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/metrics:validateMetric",
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([
'metric' => [
'displayName' => '<string>',
'entity' => '<string>',
'factTable' => '<string>',
'typeSpec' => [
],
'createTime' => [
],
'updateTime' => [
],
'creator' => '<string>',
'updater' => '<string>',
'name' => '<string>',
'description' => '<string>',
'aggregationWindow' => [
],
'exposureOffset' => [
],
'measurementConfig' => [
'openWindow' => [
]
],
'varianceReductionConfig' => [
'disabled' => true,
'aggregationWindowOverride' => [
]
],
'nullHandling' => [
'replaceMeasureNullWithZero' => true,
'replaceEntityNullWithZero' => true
],
'defaultEffectSize' => [
'value' => '<string>'
],
'filterString' => '<string>',
'deleteTime' => [
],
'labels' => [
[
]
],
'systemCreated' => true,
'owner' => '<string>',
'etag' => '<string>',
'measurement' => '<string>'
]
]),
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/metrics:validateMetric"
payload := strings.NewReader("{\n \"metric\": {\n \"displayName\": \"<string>\",\n \"entity\": \"<string>\",\n \"factTable\": \"<string>\",\n \"typeSpec\": {},\n \"createTime\": {},\n \"updateTime\": {},\n \"creator\": \"<string>\",\n \"updater\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"aggregationWindow\": {},\n \"exposureOffset\": {},\n \"measurementConfig\": {\n \"openWindow\": {}\n },\n \"varianceReductionConfig\": {\n \"disabled\": true,\n \"aggregationWindowOverride\": {}\n },\n \"nullHandling\": {\n \"replaceMeasureNullWithZero\": true,\n \"replaceEntityNullWithZero\": true\n },\n \"defaultEffectSize\": {\n \"value\": \"<string>\"\n },\n \"filterString\": \"<string>\",\n \"deleteTime\": {},\n \"labels\": [\n {}\n ],\n \"systemCreated\": true,\n \"owner\": \"<string>\",\n \"etag\": \"<string>\",\n \"measurement\": \"<string>\"\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/metrics:validateMetric")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metric\": {\n \"displayName\": \"<string>\",\n \"entity\": \"<string>\",\n \"factTable\": \"<string>\",\n \"typeSpec\": {},\n \"createTime\": {},\n \"updateTime\": {},\n \"creator\": \"<string>\",\n \"updater\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"aggregationWindow\": {},\n \"exposureOffset\": {},\n \"measurementConfig\": {\n \"openWindow\": {}\n },\n \"varianceReductionConfig\": {\n \"disabled\": true,\n \"aggregationWindowOverride\": {}\n },\n \"nullHandling\": {\n \"replaceMeasureNullWithZero\": true,\n \"replaceEntityNullWithZero\": true\n },\n \"defaultEffectSize\": {\n \"value\": \"<string>\"\n },\n \"filterString\": \"<string>\",\n \"deleteTime\": {},\n \"labels\": [\n {}\n ],\n \"systemCreated\": true,\n \"owner\": \"<string>\",\n \"etag\": \"<string>\",\n \"measurement\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://metrics.eu.confidence.dev/v1/metrics:validateMetric")
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 \"metric\": {\n \"displayName\": \"<string>\",\n \"entity\": \"<string>\",\n \"factTable\": \"<string>\",\n \"typeSpec\": {},\n \"createTime\": {},\n \"updateTime\": {},\n \"creator\": \"<string>\",\n \"updater\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"aggregationWindow\": {},\n \"exposureOffset\": {},\n \"measurementConfig\": {\n \"openWindow\": {}\n },\n \"varianceReductionConfig\": {\n \"disabled\": true,\n \"aggregationWindowOverride\": {}\n },\n \"nullHandling\": {\n \"replaceMeasureNullWithZero\": true,\n \"replaceEntityNullWithZero\": true\n },\n \"defaultEffectSize\": {\n \"value\": \"<string>\"\n },\n \"filterString\": \"<string>\",\n \"deleteTime\": {},\n \"labels\": [\n {}\n ],\n \"systemCreated\": true,\n \"owner\": \"<string>\",\n \"etag\": \"<string>\",\n \"measurement\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"category": "<string>",
"description": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200 - application/json
OK
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Validate Metric
curl --request POST \
--url https://metrics.eu.confidence.dev/v1/metrics:validateMetric \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metric": {
"displayName": "<string>",
"entity": "<string>",
"factTable": "<string>",
"typeSpec": {},
"createTime": {},
"updateTime": {},
"creator": "<string>",
"updater": "<string>",
"name": "<string>",
"description": "<string>",
"aggregationWindow": {},
"exposureOffset": {},
"measurementConfig": {
"openWindow": {}
},
"varianceReductionConfig": {
"disabled": true,
"aggregationWindowOverride": {}
},
"nullHandling": {
"replaceMeasureNullWithZero": true,
"replaceEntityNullWithZero": true
},
"defaultEffectSize": {
"value": "<string>"
},
"filterString": "<string>",
"deleteTime": {},
"labels": [
{}
],
"systemCreated": true,
"owner": "<string>",
"etag": "<string>",
"measurement": "<string>"
}
}
'import requests
url = "https://metrics.eu.confidence.dev/v1/metrics:validateMetric"
payload = { "metric": {
"displayName": "<string>",
"entity": "<string>",
"factTable": "<string>",
"typeSpec": {},
"createTime": {},
"updateTime": {},
"creator": "<string>",
"updater": "<string>",
"name": "<string>",
"description": "<string>",
"aggregationWindow": {},
"exposureOffset": {},
"measurementConfig": { "openWindow": {} },
"varianceReductionConfig": {
"disabled": True,
"aggregationWindowOverride": {}
},
"nullHandling": {
"replaceMeasureNullWithZero": True,
"replaceEntityNullWithZero": True
},
"defaultEffectSize": { "value": "<string>" },
"filterString": "<string>",
"deleteTime": {},
"labels": [{}],
"systemCreated": True,
"owner": "<string>",
"etag": "<string>",
"measurement": "<string>"
} }
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({
metric: {
displayName: '<string>',
entity: '<string>',
factTable: '<string>',
typeSpec: {},
createTime: {},
updateTime: {},
creator: '<string>',
updater: '<string>',
name: '<string>',
description: '<string>',
aggregationWindow: {},
exposureOffset: {},
measurementConfig: {openWindow: {}},
varianceReductionConfig: {disabled: true, aggregationWindowOverride: {}},
nullHandling: {replaceMeasureNullWithZero: true, replaceEntityNullWithZero: true},
defaultEffectSize: {value: '<string>'},
filterString: '<string>',
deleteTime: {},
labels: [{}],
systemCreated: true,
owner: '<string>',
etag: '<string>',
measurement: '<string>'
}
})
};
fetch('https://metrics.eu.confidence.dev/v1/metrics:validateMetric', 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/metrics:validateMetric",
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([
'metric' => [
'displayName' => '<string>',
'entity' => '<string>',
'factTable' => '<string>',
'typeSpec' => [
],
'createTime' => [
],
'updateTime' => [
],
'creator' => '<string>',
'updater' => '<string>',
'name' => '<string>',
'description' => '<string>',
'aggregationWindow' => [
],
'exposureOffset' => [
],
'measurementConfig' => [
'openWindow' => [
]
],
'varianceReductionConfig' => [
'disabled' => true,
'aggregationWindowOverride' => [
]
],
'nullHandling' => [
'replaceMeasureNullWithZero' => true,
'replaceEntityNullWithZero' => true
],
'defaultEffectSize' => [
'value' => '<string>'
],
'filterString' => '<string>',
'deleteTime' => [
],
'labels' => [
[
]
],
'systemCreated' => true,
'owner' => '<string>',
'etag' => '<string>',
'measurement' => '<string>'
]
]),
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/metrics:validateMetric"
payload := strings.NewReader("{\n \"metric\": {\n \"displayName\": \"<string>\",\n \"entity\": \"<string>\",\n \"factTable\": \"<string>\",\n \"typeSpec\": {},\n \"createTime\": {},\n \"updateTime\": {},\n \"creator\": \"<string>\",\n \"updater\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"aggregationWindow\": {},\n \"exposureOffset\": {},\n \"measurementConfig\": {\n \"openWindow\": {}\n },\n \"varianceReductionConfig\": {\n \"disabled\": true,\n \"aggregationWindowOverride\": {}\n },\n \"nullHandling\": {\n \"replaceMeasureNullWithZero\": true,\n \"replaceEntityNullWithZero\": true\n },\n \"defaultEffectSize\": {\n \"value\": \"<string>\"\n },\n \"filterString\": \"<string>\",\n \"deleteTime\": {},\n \"labels\": [\n {}\n ],\n \"systemCreated\": true,\n \"owner\": \"<string>\",\n \"etag\": \"<string>\",\n \"measurement\": \"<string>\"\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/metrics:validateMetric")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metric\": {\n \"displayName\": \"<string>\",\n \"entity\": \"<string>\",\n \"factTable\": \"<string>\",\n \"typeSpec\": {},\n \"createTime\": {},\n \"updateTime\": {},\n \"creator\": \"<string>\",\n \"updater\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"aggregationWindow\": {},\n \"exposureOffset\": {},\n \"measurementConfig\": {\n \"openWindow\": {}\n },\n \"varianceReductionConfig\": {\n \"disabled\": true,\n \"aggregationWindowOverride\": {}\n },\n \"nullHandling\": {\n \"replaceMeasureNullWithZero\": true,\n \"replaceEntityNullWithZero\": true\n },\n \"defaultEffectSize\": {\n \"value\": \"<string>\"\n },\n \"filterString\": \"<string>\",\n \"deleteTime\": {},\n \"labels\": [\n {}\n ],\n \"systemCreated\": true,\n \"owner\": \"<string>\",\n \"etag\": \"<string>\",\n \"measurement\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://metrics.eu.confidence.dev/v1/metrics:validateMetric")
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 \"metric\": {\n \"displayName\": \"<string>\",\n \"entity\": \"<string>\",\n \"factTable\": \"<string>\",\n \"typeSpec\": {},\n \"createTime\": {},\n \"updateTime\": {},\n \"creator\": \"<string>\",\n \"updater\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"aggregationWindow\": {},\n \"exposureOffset\": {},\n \"measurementConfig\": {\n \"openWindow\": {}\n },\n \"varianceReductionConfig\": {\n \"disabled\": true,\n \"aggregationWindowOverride\": {}\n },\n \"nullHandling\": {\n \"replaceMeasureNullWithZero\": true,\n \"replaceEntityNullWithZero\": true\n },\n \"defaultEffectSize\": {\n \"value\": \"<string>\"\n },\n \"filterString\": \"<string>\",\n \"deleteTime\": {},\n \"labels\": [\n {}\n ],\n \"systemCreated\": true,\n \"owner\": \"<string>\",\n \"etag\": \"<string>\",\n \"measurement\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"category": "<string>",
"description": "<string>"
}
]
}
