Skip to main content
POST
/
v1
/
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>"
}
'
{
  "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
​
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