Skip to main content
POST
/
v1
/
metric
/
policies
JavaScript
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const metricPolicy = await client.metricPolicy.create({
  metrics: [{ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],
  modality: 'call',
  name: 'Evaluate all inbound calls',
});

console.log(metricPolicy.data);
import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
metric_policy = client.metric_policy.create(
    metrics=[{
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }],
    modality="call",
    name="Evaluate all inbound calls",
)
print(metric_policy.data)
curl --request POST \
  --url https://api.roark.ai/v1/metric/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Evaluate all inbound calls",
  "modality": "call",
  "metrics": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "status": "ACTIVE",
  "conditions": [
    {
      "conditions": [
        {
          "conditionKey": "<string>",
          "conditionValue": "<string>"
        }
      ]
    }
  ]
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/metric/policies",
  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' => 'Evaluate all inbound calls',
    'modality' => 'call',
    'metrics' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'status' => 'ACTIVE',
    'conditions' => [
        [
                'conditions' => [
                                [
                                                                'conditionKey' => '<string>',
                                                                'conditionValue' => '<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://api.roark.ai/v1/metric/policies"

	payload := strings.NewReader("{\n  \"name\": \"Evaluate all inbound calls\",\n  \"modality\": \"call\",\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"status\": \"ACTIVE\",\n  \"conditions\": [\n    {\n      \"conditions\": [\n        {\n          \"conditionKey\": \"<string>\",\n          \"conditionValue\": \"<string>\"\n        }\n      ]\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://api.roark.ai/v1/metric/policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Evaluate all inbound calls\",\n  \"modality\": \"call\",\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"status\": \"ACTIVE\",\n  \"conditions\": [\n    {\n      \"conditions\": [\n        {\n          \"conditionKey\": \"<string>\",\n          \"conditionValue\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/metric/policies")

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\": \"Evaluate all inbound calls\",\n  \"modality\": \"call\",\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"status\": \"ACTIVE\",\n  \"conditions\": [\n    {\n      \"conditions\": [\n        {\n          \"conditionKey\": \"<string>\",\n          \"conditionValue\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "conditions": [
      {
        "conditions": [
          {
            "conditionKey": "<string>",
            "conditionValue": "<string>"
          }
        ]
      }
    ],
    "metrics": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}
{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}
{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}
{
  "type": "forbidden",
  "code": "permission_denied",
  "message": "You do not have permission to access this resource"
}
{
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "Rate limit exceeded"
}
{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Input for creating a new metric policy

​
name
string
required

Name of the metric policy

Minimum string length: 1
Example:

"Evaluate all inbound calls"

​
modality
enum<string>
required

Modality this policy targets. A policy fires for exactly one modality and can only reference metrics that support that modality.

Available options:
call,
chat
Example:

"call"

​
metrics
object[]
required

Metric definitions to collect when this policy matches

Minimum array length: 1
​
status
enum<string>
default:ACTIVE

Status of the policy (default: ACTIVE)

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
conditions
object[]

Condition groups. Omit to match all calls.

Response

The created metric policy

​
data
object
required

A metric policy defining when metrics should be collected