Calculated Metrics
Create Calculated Metric
Create a new calculated metric
POST
/
v1
/
calculated-metrics
Create Calculated Metric
curl --request POST \
--url https://api.oviond.com/v1/calculated-metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "CTR",
"formula": [
{
"id": "<string>",
"query": {
"data_view": "<string>",
"metrics": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"dimensions": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"filters": [
{
"id": 123,
"field": "sessionMedium",
"operator": "contains",
"value": "cpc"
}
],
"advanced": {}
},
"number": 123
}
],
"symbol": "%"
}
'import requests
url = "https://api.oviond.com/v1/calculated-metrics"
payload = {
"name": "CTR",
"formula": [
{
"id": "<string>",
"query": {
"data_view": "<string>",
"metrics": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"dimensions": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"filters": [
{
"id": 123,
"field": "sessionMedium",
"operator": "contains",
"value": "cpc"
}
],
"advanced": {}
},
"number": 123
}
],
"symbol": "%"
}
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({
name: 'CTR',
formula: [
{
id: '<string>',
query: {
data_view: '<string>',
metrics: [{value: '<string>', label: '<string>', data_view: '<string>'}],
dimensions: [{value: '<string>', label: '<string>', data_view: '<string>'}],
filters: [{id: 123, field: 'sessionMedium', operator: 'contains', value: 'cpc'}],
advanced: {}
},
number: 123
}
],
symbol: '%'
})
};
fetch('https://api.oviond.com/v1/calculated-metrics', 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://api.oviond.com/v1/calculated-metrics",
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([
'name' => 'CTR',
'formula' => [
[
'id' => '<string>',
'query' => [
'data_view' => '<string>',
'metrics' => [
[
'value' => '<string>',
'label' => '<string>',
'data_view' => '<string>'
]
],
'dimensions' => [
[
'value' => '<string>',
'label' => '<string>',
'data_view' => '<string>'
]
],
'filters' => [
[
'id' => 123,
'field' => 'sessionMedium',
'operator' => 'contains',
'value' => 'cpc'
]
],
'advanced' => [
]
],
'number' => 123
]
],
'symbol' => '%'
]),
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://api.oviond.com/v1/calculated-metrics"
payload := strings.NewReader("{\n \"name\": \"CTR\",\n \"formula\": [\n {\n \"id\": \"<string>\",\n \"query\": {\n \"data_view\": \"<string>\",\n \"metrics\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"dimensions\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"id\": 123,\n \"field\": \"sessionMedium\",\n \"operator\": \"contains\",\n \"value\": \"cpc\"\n }\n ],\n \"advanced\": {}\n },\n \"number\": 123\n }\n ],\n \"symbol\": \"%\"\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://api.oviond.com/v1/calculated-metrics")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"CTR\",\n \"formula\": [\n {\n \"id\": \"<string>\",\n \"query\": {\n \"data_view\": \"<string>\",\n \"metrics\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"dimensions\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"id\": 123,\n \"field\": \"sessionMedium\",\n \"operator\": \"contains\",\n \"value\": \"cpc\"\n }\n ],\n \"advanced\": {}\n },\n \"number\": 123\n }\n ],\n \"symbol\": \"%\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.oviond.com/v1/calculated-metrics")
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 \"name\": \"CTR\",\n \"formula\": [\n {\n \"id\": \"<string>\",\n \"query\": {\n \"data_view\": \"<string>\",\n \"metrics\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"dimensions\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"id\": 123,\n \"field\": \"sessionMedium\",\n \"operator\": \"contains\",\n \"value\": \"cpc\"\n }\n ],\n \"advanced\": {}\n },\n \"number\": 123\n }\n ],\n \"symbol\": \"%\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>"
}
}Authorizations
ApiKeyAuthBearerAuth
Oviond API key (prefix oviond_) sent as a Bearer token — the credential for REST/programmatic and headless integrations. Manage keys in Settings → API Keys. API keys do NOT authenticate the MCP endpoint (/mcp), which uses OAuth 2.1 + PKCE.
Body
application/json
Minimum string length:
1Example:
"CTR"
Array of formula tokens in evaluation order. CTR = clicks ÷ impressions × 100 is five tokens: METRIC(clicks), OPERATOR(÷), METRIC(impressions), OPERATOR(×), NUMBER(100). Operators accept both the Unicode × ÷ the UI writes and the ASCII * / on migrated rows.
Show child attributes
Show child attributes
Available options:
numbers, decimal, %, currency Example:
"%"
⌘I
Create Calculated Metric
curl --request POST \
--url https://api.oviond.com/v1/calculated-metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "CTR",
"formula": [
{
"id": "<string>",
"query": {
"data_view": "<string>",
"metrics": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"dimensions": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"filters": [
{
"id": 123,
"field": "sessionMedium",
"operator": "contains",
"value": "cpc"
}
],
"advanced": {}
},
"number": 123
}
],
"symbol": "%"
}
'import requests
url = "https://api.oviond.com/v1/calculated-metrics"
payload = {
"name": "CTR",
"formula": [
{
"id": "<string>",
"query": {
"data_view": "<string>",
"metrics": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"dimensions": [
{
"value": "<string>",
"label": "<string>",
"data_view": "<string>"
}
],
"filters": [
{
"id": 123,
"field": "sessionMedium",
"operator": "contains",
"value": "cpc"
}
],
"advanced": {}
},
"number": 123
}
],
"symbol": "%"
}
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({
name: 'CTR',
formula: [
{
id: '<string>',
query: {
data_view: '<string>',
metrics: [{value: '<string>', label: '<string>', data_view: '<string>'}],
dimensions: [{value: '<string>', label: '<string>', data_view: '<string>'}],
filters: [{id: 123, field: 'sessionMedium', operator: 'contains', value: 'cpc'}],
advanced: {}
},
number: 123
}
],
symbol: '%'
})
};
fetch('https://api.oviond.com/v1/calculated-metrics', 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://api.oviond.com/v1/calculated-metrics",
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([
'name' => 'CTR',
'formula' => [
[
'id' => '<string>',
'query' => [
'data_view' => '<string>',
'metrics' => [
[
'value' => '<string>',
'label' => '<string>',
'data_view' => '<string>'
]
],
'dimensions' => [
[
'value' => '<string>',
'label' => '<string>',
'data_view' => '<string>'
]
],
'filters' => [
[
'id' => 123,
'field' => 'sessionMedium',
'operator' => 'contains',
'value' => 'cpc'
]
],
'advanced' => [
]
],
'number' => 123
]
],
'symbol' => '%'
]),
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://api.oviond.com/v1/calculated-metrics"
payload := strings.NewReader("{\n \"name\": \"CTR\",\n \"formula\": [\n {\n \"id\": \"<string>\",\n \"query\": {\n \"data_view\": \"<string>\",\n \"metrics\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"dimensions\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"id\": 123,\n \"field\": \"sessionMedium\",\n \"operator\": \"contains\",\n \"value\": \"cpc\"\n }\n ],\n \"advanced\": {}\n },\n \"number\": 123\n }\n ],\n \"symbol\": \"%\"\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://api.oviond.com/v1/calculated-metrics")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"CTR\",\n \"formula\": [\n {\n \"id\": \"<string>\",\n \"query\": {\n \"data_view\": \"<string>\",\n \"metrics\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"dimensions\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"id\": 123,\n \"field\": \"sessionMedium\",\n \"operator\": \"contains\",\n \"value\": \"cpc\"\n }\n ],\n \"advanced\": {}\n },\n \"number\": 123\n }\n ],\n \"symbol\": \"%\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.oviond.com/v1/calculated-metrics")
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 \"name\": \"CTR\",\n \"formula\": [\n {\n \"id\": \"<string>\",\n \"query\": {\n \"data_view\": \"<string>\",\n \"metrics\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"dimensions\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"data_view\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"id\": 123,\n \"field\": \"sessionMedium\",\n \"operator\": \"contains\",\n \"value\": \"cpc\"\n }\n ],\n \"advanced\": {}\n },\n \"number\": 123\n }\n ],\n \"symbol\": \"%\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>"
}
}