Evaluate Metrics

Run specific metrics against call logs

curl --request POST \
  --url https://api.cekura.ai/observability/v1/call-logs/evaluate_metrics/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "call_logs": [
    123
  ],
  "metrics": [
    123
  ],
  "agent_id": 123,
  "project_id": 123
}
'

import requests

url = "https://api.cekura.ai/observability/v1/call-logs/evaluate_metrics/"

payload = {
    "call_logs": [123],
    "metrics": [123],
    "agent_id": 123,
    "project_id": 123
}
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({call_logs: [123], metrics: [123], agent_id: 123, project_id: 123})
};

fetch('https://api.cekura.ai/observability/v1/call-logs/evaluate_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.cekura.ai/observability/v1/call-logs/evaluate_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([
    'call_logs' => [
        123
    ],
    'metrics' => [
        123
    ],
    'agent_id' => 123,
    'project_id' => 123
  ]),
  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.cekura.ai/observability/v1/call-logs/evaluate_metrics/"

	payload := strings.NewReader("{\n  \"call_logs\": [\n    123\n  ],\n  \"metrics\": [\n    123\n  ],\n  \"agent_id\": 123,\n  \"project_id\": 123\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.cekura.ai/observability/v1/call-logs/evaluate_metrics/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_logs\": [\n    123\n  ],\n  \"metrics\": [\n    123\n  ],\n  \"agent_id\": 123,\n  \"project_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/observability/v1/call-logs/evaluate_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  \"call_logs\": [\n    123\n  ],\n  \"metrics\": [\n    123\n  ],\n  \"agent_id\": 123,\n  \"project_id\": 123\n}"

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

[
  {
    "call_id": "<string>",
    "id": 123,
    "duration": "<string>",
    "success": true,
    "is_reviewed": true,
    "status": "success",
    "feedback": "<string>",
    "metrics": [
      {
        "id": 123,
        "name": "<string>",
        "type": "<string>",
        "score": 123,
        "enum": "<string>",
        "value": "<string>"
      }
    ],
    "call_ended_reason": "<string>",
    "customer_number": "<string>",
    "agent": 123,
    "agent_name": "<string>",
    "trace_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "error_message": "<string>",
    "dropoff_point": "<string>",
    "topic": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "transcript": "<string>",
    "transcript_object": "<string>",
    "evaluation": "<string>"
  }
]

{
  "field_name": [
    "<string>"
  ]
}

POST

observability

call-logs

evaluate_metrics

Run specific metrics against call logs

curl --request POST \
  --url https://api.cekura.ai/observability/v1/call-logs/evaluate_metrics/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "call_logs": [
    123
  ],
  "metrics": [
    123
  ],
  "agent_id": 123,
  "project_id": 123
}
'

import requests

url = "https://api.cekura.ai/observability/v1/call-logs/evaluate_metrics/"

payload = {
    "call_logs": [123],
    "metrics": [123],
    "agent_id": 123,
    "project_id": 123
}
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({call_logs: [123], metrics: [123], agent_id: 123, project_id: 123})
};

fetch('https://api.cekura.ai/observability/v1/call-logs/evaluate_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.cekura.ai/observability/v1/call-logs/evaluate_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([
    'call_logs' => [
        123
    ],
    'metrics' => [
        123
    ],
    'agent_id' => 123,
    'project_id' => 123
  ]),
  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.cekura.ai/observability/v1/call-logs/evaluate_metrics/"

	payload := strings.NewReader("{\n  \"call_logs\": [\n    123\n  ],\n  \"metrics\": [\n    123\n  ],\n  \"agent_id\": 123,\n  \"project_id\": 123\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.cekura.ai/observability/v1/call-logs/evaluate_metrics/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_logs\": [\n    123\n  ],\n  \"metrics\": [\n    123\n  ],\n  \"agent_id\": 123,\n  \"project_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/observability/v1/call-logs/evaluate_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  \"call_logs\": [\n    123\n  ],\n  \"metrics\": [\n    123\n  ],\n  \"agent_id\": 123,\n  \"project_id\": 123\n}"

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

[
  {
    "call_id": "<string>",
    "id": 123,
    "duration": "<string>",
    "success": true,
    "is_reviewed": true,
    "status": "success",
    "feedback": "<string>",
    "metrics": [
      {
        "id": 123,
        "name": "<string>",
        "type": "<string>",
        "score": 123,
        "enum": "<string>",
        "value": "<string>"
      }
    ],
    "call_ended_reason": "<string>",
    "customer_number": "<string>",
    "agent": 123,
    "agent_name": "<string>",
    "trace_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "error_message": "<string>",
    "dropoff_point": "<string>",
    "topic": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "transcript": "<string>",
    "transcript_object": "<string>",
    "evaluation": "<string>"
  }
]

{
  "field_name": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

OAuth access token issued by Cekura for connected apps.

Body

call_logs

integer[]

required

IDs of the call logs to evaluate. Example: [123, 456]

metrics

integer[]

required

IDs of the metrics to run. Must belong to the agent/project. Example: [789, 790]

agent_id

integer

Cekura agent ID. Provide this or project_id. Example: 224

project_id

integer

Project ID. Provide this or agent_id. Example: 456

Response

call_id

string

required

Unique identifier for the call. Example:

"call_abc123xyz"
"stereo_audio_session_456"

Maximum string length: 100

integer

read-only

duration

string

read-only

Call duration in minutes in MM:SS format. Example: 01:10

success

boolean | null

Whether the call was successful. Example: true or false

is_reviewed

boolean

Whether the call has been reviewed. Example: true or false

status

enum<string>

Status of the call or conversation. Example: "completed" or "failed"

success - Success
failure - Failure
reviewed_success - Reviewed Success
reviewed_failure - Reviewed Failure

Available options:

success,

failure,

reviewed_success,

reviewed_failure

feedback

string

Feedback about the call. Example: "Great Call"

metrics

object[]

read-only

Metrics of the call

Show child attributes

call_ended_reason

string

Reason why the call ended. Example:

"customer-ended-call"
"agent-ended-call"

Maximum string length: 100

customer_number

string

Customer's phone number or identifier. Example:

"+1234567890"
"customer_abc123"

Maximum string length: 100

agent

integer | null

Agent ID

agent_name

string

read-only

Agent name

trace_id

string

OpenTelemetry trace ID (32-char hex). Set when OTel tracing is enabled.

Maximum string length: 32

timestamp

string<date-time>

When the call occurred. Example: 2024-03-15T10:15:45Z

error_message

string | null

dropoff_point

string

Point in conversation where user disengaged. Example: "end of conversation as no queries remaining"

Maximum string length: 1000

topic

string

Topic of the call. Example:

"product_inquiry"
"technical_support"

Maximum string length: 1000

created_at

string<date-time>

read-only

When this record was created. Example: 2024-03-15T10:30:45Z

updated_at

string<date-time>

read-only

When this record was last updated. Example: 2024-03-15T10:35:11Z

transcript

string

Full text transcript of the call. Example:

[00:01] Testing Agent: Hello. 
[00:02] Main Agent: Hello, how can I help you today?
[00:03] Testing Agent: Well, I mean, sure. What time exactly are we talking about here
[00:04] Main Agent: 6 PM.
[00:05] Testing Agent: Great. I'll book that for you. Just a sec.
[00:06] Main Agent: Okay.

transcript_object

string

read-only

Structured transcript data with timestamps. Example:

[
    {
        "role": "Testing Agent",
        "content": "Hello",
        "start_time": 1.2,
        "end_time": 1.8
    },
    {
        "role": "Main Agent",
        "content": "Hello, how can I help you today?",
        "start_time": 1.8,
        "end_time": 2.5
    }
]`

evaluation

string

read-only

Evaluation of the call

⌘I