Estimate transcript evaluation

curl --request POST \
  --url https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "evaluationIDs": [
    "<string>"
  ],
  "filters": [
    {
      "id": "<string>",
      "value": 123
    }
  ],
  "endDate": "2023-11-07T05:31:56Z",
  "sessionID": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "updatedAfter": "2023-11-07T05:31:56Z",
  "updatedBefore": "2023-11-07T05:31:56Z",
  "environmentID": "<string>",
  "versionID": "<string>",
  "projectEnvironmentIDOrAlias": "<string>"
}
'

import requests

url = "https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate"

payload = {
    "evaluationIDs": ["<string>"],
    "filters": [
        {
            "id": "<string>",
            "value": 123
        }
    ],
    "endDate": "2023-11-07T05:31:56Z",
    "sessionID": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "updatedAfter": "2023-11-07T05:31:56Z",
    "updatedBefore": "2023-11-07T05:31:56Z",
    "environmentID": "<string>",
    "versionID": "<string>",
    "projectEnvironmentIDOrAlias": "<string>"
}
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    evaluationIDs: ['<string>'],
    filters: [{id: '<string>', value: 123}],
    endDate: '2023-11-07T05:31:56Z',
    sessionID: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    updatedAfter: '2023-11-07T05:31:56Z',
    updatedBefore: '2023-11-07T05:31:56Z',
    environmentID: '<string>',
    versionID: '<string>',
    projectEnvironmentIDOrAlias: '<string>'
  })
};

fetch('https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate', 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://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate",
  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([
    'evaluationIDs' => [
        '<string>'
    ],
    'filters' => [
        [
                'id' => '<string>',
                'value' => 123
        ]
    ],
    'endDate' => '2023-11-07T05:31:56Z',
    'sessionID' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'updatedAfter' => '2023-11-07T05:31:56Z',
    'updatedBefore' => '2023-11-07T05:31:56Z',
    'environmentID' => '<string>',
    'versionID' => '<string>',
    'projectEnvironmentIDOrAlias' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$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://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate"

	payload := strings.NewReader("{\n  \"evaluationIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"sessionID\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"updatedAfter\": \"2023-11-07T05:31:56Z\",\n  \"updatedBefore\": \"2023-11-07T05:31:56Z\",\n  \"environmentID\": \"<string>\",\n  \"versionID\": \"<string>\",\n  \"projectEnvironmentIDOrAlias\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<api-key>")
	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://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"evaluationIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"sessionID\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"updatedAfter\": \"2023-11-07T05:31:56Z\",\n  \"updatedBefore\": \"2023-11-07T05:31:56Z\",\n  \"environmentID\": \"<string>\",\n  \"versionID\": \"<string>\",\n  \"projectEnvironmentIDOrAlias\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"evaluationIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"sessionID\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"updatedAfter\": \"2023-11-07T05:31:56Z\",\n  \"updatedBefore\": \"2023-11-07T05:31:56Z\",\n  \"environmentID\": \"<string>\",\n  \"versionID\": \"<string>\",\n  \"projectEnvironmentIDOrAlias\": \"<string>\"\n}"

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

{
  "totalCost": 123,
  "breakdown": {
    "transcriptCount": 123,
    "evaluations": [
      {
        "id": "<string>",
        "cost": 123
      }
    ]
  }
}

POST

transcript-evaluation

estimate

Estimate transcript evaluation

curl --request POST \
  --url https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "evaluationIDs": [
    "<string>"
  ],
  "filters": [
    {
      "id": "<string>",
      "value": 123
    }
  ],
  "endDate": "2023-11-07T05:31:56Z",
  "sessionID": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "updatedAfter": "2023-11-07T05:31:56Z",
  "updatedBefore": "2023-11-07T05:31:56Z",
  "environmentID": "<string>",
  "versionID": "<string>",
  "projectEnvironmentIDOrAlias": "<string>"
}
'

import requests

url = "https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate"

payload = {
    "evaluationIDs": ["<string>"],
    "filters": [
        {
            "id": "<string>",
            "value": 123
        }
    ],
    "endDate": "2023-11-07T05:31:56Z",
    "sessionID": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "updatedAfter": "2023-11-07T05:31:56Z",
    "updatedBefore": "2023-11-07T05:31:56Z",
    "environmentID": "<string>",
    "versionID": "<string>",
    "projectEnvironmentIDOrAlias": "<string>"
}
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    evaluationIDs: ['<string>'],
    filters: [{id: '<string>', value: 123}],
    endDate: '2023-11-07T05:31:56Z',
    sessionID: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    updatedAfter: '2023-11-07T05:31:56Z',
    updatedBefore: '2023-11-07T05:31:56Z',
    environmentID: '<string>',
    versionID: '<string>',
    projectEnvironmentIDOrAlias: '<string>'
  })
};

fetch('https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate', 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://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate",
  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([
    'evaluationIDs' => [
        '<string>'
    ],
    'filters' => [
        [
                'id' => '<string>',
                'value' => 123
        ]
    ],
    'endDate' => '2023-11-07T05:31:56Z',
    'sessionID' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'updatedAfter' => '2023-11-07T05:31:56Z',
    'updatedBefore' => '2023-11-07T05:31:56Z',
    'environmentID' => '<string>',
    'versionID' => '<string>',
    'projectEnvironmentIDOrAlias' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$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://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate"

	payload := strings.NewReader("{\n  \"evaluationIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"sessionID\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"updatedAfter\": \"2023-11-07T05:31:56Z\",\n  \"updatedBefore\": \"2023-11-07T05:31:56Z\",\n  \"environmentID\": \"<string>\",\n  \"versionID\": \"<string>\",\n  \"projectEnvironmentIDOrAlias\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<api-key>")
	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://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"evaluationIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"sessionID\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"updatedAfter\": \"2023-11-07T05:31:56Z\",\n  \"updatedBefore\": \"2023-11-07T05:31:56Z\",\n  \"environmentID\": \"<string>\",\n  \"versionID\": \"<string>\",\n  \"projectEnvironmentIDOrAlias\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://analytics-api.voiceflow.com/v1/transcript-evaluation/estimate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"evaluationIDs\": [\n    \"<string>\"\n  ],\n  \"filters\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"sessionID\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"updatedAfter\": \"2023-11-07T05:31:56Z\",\n  \"updatedBefore\": \"2023-11-07T05:31:56Z\",\n  \"environmentID\": \"<string>\",\n  \"versionID\": \"<string>\",\n  \"projectEnvironmentIDOrAlias\": \"<string>\"\n}"

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

{
  "totalCost": 123,
  "breakdown": {
    "transcriptCount": 123,
    "evaluations": [
      {
        "id": "<string>",
        "cost": 123
      }
    ]
  }
}

Authorizations

authorization

string

header

required

Voiceflow API key

Body

application/json

evaluationIDs

string[]

required

Minimum array length: 1

Required string length: 24

filters

object[]

Filter transcripts based on properties and evaluation results.

Maximum array length: 50

Hide child attributes

filters.id

string

required

filters.op

enum<string>

required

Available options:

gt,

gte,

lt,

lte

filters.value

number

required

endDate

string<date-time>

Select transcripts that were started before a specific date.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

sessionID

string

Select transcripts by sessionID.

startDate

string<date-time>

Select transcripts that were started after a specific date.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAfter

string<date-time>

Select transcripts that were last updated at or after a specific date.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedBefore

string<date-time>

Select transcripts that were last updated at or before a specific date.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

environmentID

deprecated

@deprecated use versionID and projectEnvironmentIDOrAlias instead

versionID

string

projectEnvironmentIDOrAlias

string

Response

200 - application/json

totalCost

number

required

breakdown

object

required

Hide child attributes

breakdown.transcriptCount

number

required

breakdown.evaluations

object[]

required

Hide child attributes

breakdown.evaluations.id

string

required

breakdown.evaluations.cost

number

required

Batch run transcript evaluations

Knowledge base API

Conversations API

Analytics API

Knowledge base API

Project API

Webhooks

Estimate transcript evaluation

Authorizations

Body

Response