Cancel MetricCalculation

POST

scheduledMetricCalculations

{scheduledMetricCalculation}

metricCalculations

{metricCalculation}

:cancel

Cancel MetricCalculation

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel"

payload = {}
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({})
};

fetch('https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel', 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}/metricCalculations/{metricCalculation}:cancel",
  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([
    
  ]),
  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}/metricCalculations/{metricCalculation}:cancel"

	payload := strings.NewReader("{}")

	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}/metricCalculations/{metricCalculation}:cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel")

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 = "{}"

response = http.request(request)
puts response.read_body

{
  "metricCalculationSpec": {
    "metric": "<string>",
    "exposureTable": "<string>",
    "splitDimensions": [
      {
        "column": "<string>",
        "factTable": "<string>",
        "dimensionTable": "<string>",
        "exposureTable": "<string>"
      }
    ],
    "measurementTable": "<string>",
    "exposureGroups": [
      "<string>"
    ]
  },
  "startTime": {},
  "scheduleIteration": {},
  "times": {
    "exposureStartTime": {},
    "exposureEndTime": {},
    "factStartTime": {},
    "factEndTime": {}
  },
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "endTime": {},
  "state": "STATE_UNSPECIFIED",
  "metricResults": {
    "metricBucketStats": [
      {
        "summaryStats": {
          "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
            }
          }
        },
        "variant": "<string>",
        "dimensions": [
          {
            "dimension": "<string>",
            "value": "<string>"
          }
        ]
      }
    ]
  },
  "schedule": "<string>",
  "sqlJob": "<string>",
  "supersededBy": "<string>",
  "sql": "<string>",
  "superseeds": "<string>",
  "retriggered": true,
  "outdatedSourceDataInfo": {
    "table": "<string>",
    "expectedCount": 123,
    "actualCount": 123,
    "queryStartTime": {},
    "queryEndTime": {}
  },
  "error": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

scheduledMetricCalculation

string

required

metricCalculation

string

required

Body

application/json

The body is of type object.

Response

200 - application/json

Returns a MetricCalculation.

Represents the calculation of a metric for a specific time window.

metricCalculationSpec

object

required

The metric to calculate.

Show child attributes

startTime

object

required

Start time of the calculation in terms of exposure.

scheduleIteration

object

required

The iteration of the schedule that this calculation belongs to.

times

object

required

Info about the start / end timestamps used for the calculation

Show child attributes

createTime

object

required

Time when the metric calculation was first created.

updateTime

object

required

Time when the metric calculation was last updated.

creator

string

required

Reference to the identity that created this metric calculation.

updater

string

required

Reference to the identity that last updated this metric calculation.

name

string

Unique identifier of the metric calculation. For example: metricCalculations/0smva5nxuhv4yts6paxt

endTime

object

End time of the calculation in terms of facts. Must be set if exposure_end_time is not set, if exposure_end_time is set, this field will be set to the inferred fact end time.

state

enum<string>

Current state of the calculation.

Available options:

STATE_UNSPECIFIED,

STATE_FAILED,

STATE_RUNNING,

STATE_COMPLETED,

STATE_CANCELLED

metricResults

object

Holds the results of the metric calculate when completed.

Show child attributes

schedule

string

Resource reference to the schedule if the calculation originated from a schedule.

sqlJob

string

Resource name of the corresponding job that performs the calculation.

supersededBy

string

Set if the metric calculation has been replaced by a newer calculation, occurs for example when parameters of the metric changes.

sql

string

The warehouse-specific query that is used to perform the calculation.

superseeds

string

Set if this metric calculation replaced an older metric calculation.

retriggered

boolean

Determines whether this calculation overlaps with a retriggered range

outdatedSourceDataInfo

object

If the underlying tables changed for the queried values since running the calculation, this contains information about what changed and where.

Show child attributes

error

string

Descriptive error if the calculation failed.

labels

object[]

Custom labels for this metric calculation.

Show child attributes

owner

string

The owner of the resource. If not set will default to the creator.

⌘I

Cancel MetricCalculation

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel"

payload = {}
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({})
};

fetch('https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel', 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}/metricCalculations/{metricCalculation}:cancel",
  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([
    
  ]),
  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}/metricCalculations/{metricCalculation}:cancel"

	payload := strings.NewReader("{}")

	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}/metricCalculations/{metricCalculation}:cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:cancel")

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 = "{}"

response = http.request(request)
puts response.read_body

{
  "metricCalculationSpec": {
    "metric": "<string>",
    "exposureTable": "<string>",
    "splitDimensions": [
      {
        "column": "<string>",
        "factTable": "<string>",
        "dimensionTable": "<string>",
        "exposureTable": "<string>"
      }
    ],
    "measurementTable": "<string>",
    "exposureGroups": [
      "<string>"
    ]
  },
  "startTime": {},
  "scheduleIteration": {},
  "times": {
    "exposureStartTime": {},
    "exposureEndTime": {},
    "factStartTime": {},
    "factEndTime": {}
  },
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "endTime": {},
  "state": "STATE_UNSPECIFIED",
  "metricResults": {
    "metricBucketStats": [
      {
        "summaryStats": {
          "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
            }
          }
        },
        "variant": "<string>",
        "dimensions": [
          {
            "dimension": "<string>",
            "value": "<string>"
          }
        ]
      }
    ]
  },
  "schedule": "<string>",
  "sqlJob": "<string>",
  "supersededBy": "<string>",
  "sql": "<string>",
  "superseeds": "<string>",
  "retriggered": true,
  "outdatedSourceDataInfo": {
    "table": "<string>",
    "expectedCount": 123,
    "actualCount": 123,
    "queryStartTime": {},
    "queryEndTime": {}
  },
  "error": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}

Get Started

Feature Flags

Metrics

Stats

Experiments

Surfaces

IAM

Connectors

Authorizations

Path Parameters

Body

Response