Create ScheduledMetricCalculation

POST

scheduledMetricCalculations

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metricCalculationSpec": {
    "metric": "<string>",
    "exposureTable": "<string>",
    "splitDimensions": [
      {
        "column": "<string>",
        "factTable": "<string>",
        "dimensionTable": "<string>",
        "exposureTable": "<string>"
      }
    ],
    "measurementTable": "<string>",
    "exposureGroups": [
      "<string>"
    ]
  },
  "scheduleStartTime": {},
  "scheduleIntervals": [
    {}
  ],
  "name": "<string>",
  "scheduleEndTime": {},
  "labels": [
    {}
  ],
  "owner": "<string>"
}
'

import requests

url = "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations"

payload = {
    "metricCalculationSpec": {
        "metric": "<string>",
        "exposureTable": "<string>",
        "splitDimensions": [
            {
                "column": "<string>",
                "factTable": "<string>",
                "dimensionTable": "<string>",
                "exposureTable": "<string>"
            }
        ],
        "measurementTable": "<string>",
        "exposureGroups": ["<string>"]
    },
    "scheduleStartTime": {},
    "scheduleIntervals": [{}],
    "name": "<string>",
    "scheduleEndTime": {},
    "labels": [{}],
    "owner": "<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({
    metricCalculationSpec: {
      metric: '<string>',
      exposureTable: '<string>',
      splitDimensions: [
        {
          column: '<string>',
          factTable: '<string>',
          dimensionTable: '<string>',
          exposureTable: '<string>'
        }
      ],
      measurementTable: '<string>',
      exposureGroups: ['<string>']
    },
    scheduleStartTime: {},
    scheduleIntervals: [{}],
    name: '<string>',
    scheduleEndTime: {},
    labels: [{}],
    owner: '<string>'
  })
};

fetch('https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations', 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",
  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([
    'metricCalculationSpec' => [
        'metric' => '<string>',
        'exposureTable' => '<string>',
        'splitDimensions' => [
                [
                                'column' => '<string>',
                                'factTable' => '<string>',
                                'dimensionTable' => '<string>',
                                'exposureTable' => '<string>'
                ]
        ],
        'measurementTable' => '<string>',
        'exposureGroups' => [
                '<string>'
        ]
    ],
    'scheduleStartTime' => [
        
    ],
    'scheduleIntervals' => [
        [
                
        ]
    ],
    'name' => '<string>',
    'scheduleEndTime' => [
        
    ],
    'labels' => [
        [
                
        ]
    ],
    'owner' => '<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/scheduledMetricCalculations"

	payload := strings.NewReader("{\n  \"metricCalculationSpec\": {\n    \"metric\": \"<string>\",\n    \"exposureTable\": \"<string>\",\n    \"splitDimensions\": [\n      {\n        \"column\": \"<string>\",\n        \"factTable\": \"<string>\",\n        \"dimensionTable\": \"<string>\",\n        \"exposureTable\": \"<string>\"\n      }\n    ],\n    \"measurementTable\": \"<string>\",\n    \"exposureGroups\": [\n      \"<string>\"\n    ]\n  },\n  \"scheduleStartTime\": {},\n  \"scheduleIntervals\": [\n    {}\n  ],\n  \"name\": \"<string>\",\n  \"scheduleEndTime\": {},\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metricCalculationSpec\": {\n    \"metric\": \"<string>\",\n    \"exposureTable\": \"<string>\",\n    \"splitDimensions\": [\n      {\n        \"column\": \"<string>\",\n        \"factTable\": \"<string>\",\n        \"dimensionTable\": \"<string>\",\n        \"exposureTable\": \"<string>\"\n      }\n    ],\n    \"measurementTable\": \"<string>\",\n    \"exposureGroups\": [\n      \"<string>\"\n    ]\n  },\n  \"scheduleStartTime\": {},\n  \"scheduleIntervals\": [\n    {}\n  ],\n  \"name\": \"<string>\",\n  \"scheduleEndTime\": {},\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations")

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  \"metricCalculationSpec\": {\n    \"metric\": \"<string>\",\n    \"exposureTable\": \"<string>\",\n    \"splitDimensions\": [\n      {\n        \"column\": \"<string>\",\n        \"factTable\": \"<string>\",\n        \"dimensionTable\": \"<string>\",\n        \"exposureTable\": \"<string>\"\n      }\n    ],\n    \"measurementTable\": \"<string>\",\n    \"exposureGroups\": [\n      \"<string>\"\n    ]\n  },\n  \"scheduleStartTime\": {},\n  \"scheduleIntervals\": [\n    {}\n  ],\n  \"name\": \"<string>\",\n  \"scheduleEndTime\": {},\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}"

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>"
    ]
  },
  "scheduleStartTime": {},
  "scheduleIntervals": [
    {}
  ],
  "iteration": {},
  "nextScheduledRunTime": {},
  "nextExposureStartTime": {},
  "nextExposureEndTime": {},
  "executedCalculationsCount": {},
  "createTime": {},
  "updateTime": {},
  "status": {
    "scheduled": {
      "nextScheduleTime": {}
    },
    "cancelled": {
      "cancelledTime": {}
    },
    "calculating": {
      "metricCalculation": "<string>"
    },
    "waiting": {
      "needDataUntilTime": {},
      "factTable": "<string>",
      "exposureTable": "<string>",
      "measurementTable": "<string>",
      "dimensionTable": "<string>",
      "dataDeliveredUntilTime": {}
    },
    "error": {
      "errorMessage": "<string>"
    }
  },
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "scheduleEndTime": {},
  "state": "STATE_UNSPECIFIED",
  "latestCalculation": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "activeRetrigger": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

scheduledMetricCalculationId

string

The id to the give the created scheduled metric calculation. If a not set a random one will be generated.

Body

application/json

metricCalculationSpec

object

required

The specification to use for each metric calculation

Show child attributes

scheduleStartTime

object

required

The time when the first metric calculation will start. This timestamp is the start time of the first metric calculation. The schedule will execute this calculation when there is enough data and the interval has passed.

scheduleIntervals

object[]

required

The intervals for which to trigger metric calculations. The first calculation will use the first interval the second will use the second iteration and so forth. Once the last interval is reached the schedule will stay at that interval

name

string

Unique identifier of the scheduled metric calculations. For example: scheduledMetricCalculations/0smva5nxuhv4yts6paxt

scheduleEndTime

object

The time when the metric calculation will end. Once the schedule reaches the end it will be cancelled and no new calculations will be triggered. If no end is specified the schedule will continue indefinitely.

labels

object[]

Custom labels for this scheduled metric calculation.

Show child attributes

owner

string

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

Response

200 - application/json

Returns a ScheduledMetricCalculation.

Represents a schedule of metric calculations. Will trigger new calculations at the specified intervals.

metricCalculationSpec

object

required

The specification to use for each metric calculation

Show child attributes

scheduleStartTime

object

required

scheduleIntervals

object[]

required

iteration

object

required

The iteration of the schedule. A new iteration is created every time the schedule is retriggered.

nextScheduledRunTime

object

required

The time when the metric calculation is scheduled to run the next time.If the calculation is cancelled, this field contains the latest time it was scheduled to run before cancellation.

nextExposureStartTime

object

required

The start time of exposure for the next scheduled run.

nextExposureEndTime

object

required

The end time of exposure for the next scheduled run.

executedCalculationsCount

object

required

The number of calculations that has been executed so far.

createTime

object

required

The time the scheduled metric calculation was first created.

updateTime

object

required

Time when the scheduled metric calculation was last updated.

status

object

required

Status of the schedule. This explains more in depth of where the schedule is now, if it's waiting for data or if it's currently executing

Show child attributes

creator

string

required

Reference to the identity that created this scheduled metric calculation.

updater

string

required

Reference to the identity that last updated this scheduled metric calculation.

name

string

Unique identifier of the scheduled metric calculations. For example: scheduledMetricCalculations/0smva5nxuhv4yts6paxt

scheduleEndTime

object

state

enum<string>

The current state of the schedule

Available options:

STATE_UNSPECIFIED,

ACTIVE,

CANCELLED

latestCalculation

string

The name of the latest calculation that this schedule triggered

labels

object[]

Custom labels for this scheduled metric calculation.

Show child attributes

owner

string

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

activeRetrigger

string

Reference to a retrigger if one is active.

⌘I

Create ScheduledMetricCalculation

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metricCalculationSpec": {
    "metric": "<string>",
    "exposureTable": "<string>",
    "splitDimensions": [
      {
        "column": "<string>",
        "factTable": "<string>",
        "dimensionTable": "<string>",
        "exposureTable": "<string>"
      }
    ],
    "measurementTable": "<string>",
    "exposureGroups": [
      "<string>"
    ]
  },
  "scheduleStartTime": {},
  "scheduleIntervals": [
    {}
  ],
  "name": "<string>",
  "scheduleEndTime": {},
  "labels": [
    {}
  ],
  "owner": "<string>"
}
'

import requests

url = "https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations"

payload = {
    "metricCalculationSpec": {
        "metric": "<string>",
        "exposureTable": "<string>",
        "splitDimensions": [
            {
                "column": "<string>",
                "factTable": "<string>",
                "dimensionTable": "<string>",
                "exposureTable": "<string>"
            }
        ],
        "measurementTable": "<string>",
        "exposureGroups": ["<string>"]
    },
    "scheduleStartTime": {},
    "scheduleIntervals": [{}],
    "name": "<string>",
    "scheduleEndTime": {},
    "labels": [{}],
    "owner": "<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({
    metricCalculationSpec: {
      metric: '<string>',
      exposureTable: '<string>',
      splitDimensions: [
        {
          column: '<string>',
          factTable: '<string>',
          dimensionTable: '<string>',
          exposureTable: '<string>'
        }
      ],
      measurementTable: '<string>',
      exposureGroups: ['<string>']
    },
    scheduleStartTime: {},
    scheduleIntervals: [{}],
    name: '<string>',
    scheduleEndTime: {},
    labels: [{}],
    owner: '<string>'
  })
};

fetch('https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations', 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",
  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([
    'metricCalculationSpec' => [
        'metric' => '<string>',
        'exposureTable' => '<string>',
        'splitDimensions' => [
                [
                                'column' => '<string>',
                                'factTable' => '<string>',
                                'dimensionTable' => '<string>',
                                'exposureTable' => '<string>'
                ]
        ],
        'measurementTable' => '<string>',
        'exposureGroups' => [
                '<string>'
        ]
    ],
    'scheduleStartTime' => [
        
    ],
    'scheduleIntervals' => [
        [
                
        ]
    ],
    'name' => '<string>',
    'scheduleEndTime' => [
        
    ],
    'labels' => [
        [
                
        ]
    ],
    'owner' => '<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/scheduledMetricCalculations"

	payload := strings.NewReader("{\n  \"metricCalculationSpec\": {\n    \"metric\": \"<string>\",\n    \"exposureTable\": \"<string>\",\n    \"splitDimensions\": [\n      {\n        \"column\": \"<string>\",\n        \"factTable\": \"<string>\",\n        \"dimensionTable\": \"<string>\",\n        \"exposureTable\": \"<string>\"\n      }\n    ],\n    \"measurementTable\": \"<string>\",\n    \"exposureGroups\": [\n      \"<string>\"\n    ]\n  },\n  \"scheduleStartTime\": {},\n  \"scheduleIntervals\": [\n    {}\n  ],\n  \"name\": \"<string>\",\n  \"scheduleEndTime\": {},\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metricCalculationSpec\": {\n    \"metric\": \"<string>\",\n    \"exposureTable\": \"<string>\",\n    \"splitDimensions\": [\n      {\n        \"column\": \"<string>\",\n        \"factTable\": \"<string>\",\n        \"dimensionTable\": \"<string>\",\n        \"exposureTable\": \"<string>\"\n      }\n    ],\n    \"measurementTable\": \"<string>\",\n    \"exposureGroups\": [\n      \"<string>\"\n    ]\n  },\n  \"scheduleStartTime\": {},\n  \"scheduleIntervals\": [\n    {}\n  ],\n  \"name\": \"<string>\",\n  \"scheduleEndTime\": {},\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations")

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  \"metricCalculationSpec\": {\n    \"metric\": \"<string>\",\n    \"exposureTable\": \"<string>\",\n    \"splitDimensions\": [\n      {\n        \"column\": \"<string>\",\n        \"factTable\": \"<string>\",\n        \"dimensionTable\": \"<string>\",\n        \"exposureTable\": \"<string>\"\n      }\n    ],\n    \"measurementTable\": \"<string>\",\n    \"exposureGroups\": [\n      \"<string>\"\n    ]\n  },\n  \"scheduleStartTime\": {},\n  \"scheduleIntervals\": [\n    {}\n  ],\n  \"name\": \"<string>\",\n  \"scheduleEndTime\": {},\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}"

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>"
    ]
  },
  "scheduleStartTime": {},
  "scheduleIntervals": [
    {}
  ],
  "iteration": {},
  "nextScheduledRunTime": {},
  "nextExposureStartTime": {},
  "nextExposureEndTime": {},
  "executedCalculationsCount": {},
  "createTime": {},
  "updateTime": {},
  "status": {
    "scheduled": {
      "nextScheduleTime": {}
    },
    "cancelled": {
      "cancelledTime": {}
    },
    "calculating": {
      "metricCalculation": "<string>"
    },
    "waiting": {
      "needDataUntilTime": {},
      "factTable": "<string>",
      "exposureTable": "<string>",
      "measurementTable": "<string>",
      "dimensionTable": "<string>",
      "dataDeliveredUntilTime": {}
    },
    "error": {
      "errorMessage": "<string>"
    }
  },
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "scheduleEndTime": {},
  "state": "STATE_UNSPECIFIED",
  "latestCalculation": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "activeRetrigger": "<string>"
}

Get Started

Feature Flags

Metrics

Stats

Experiments

Surfaces

IAM

Connectors

Authorizations

Query Parameters

Body

Response