/search term parameters
Use these parameters to filter search queries to certain transcription and analytics metadata values.
- agent_clarity=$n-$m
- Search for audio records with agent voice clarity percentage within the range of $n to $m, which are floating point values. A score closer to 1 indicates higher clarity. Low clarity is the result of poor signal, background noise, accent, or poor enunciation. For example:
agent_clarity=0.6-1.0
- agent_emotion=$emotion
Search for audio records where the emotional score of the agent's portion of the audio is $emotion. Possible values for $emotion are
Improving
,Negative
,Positive
, andWorsening
. Only oneagent_emotion
value can be used within a single search. For example:agent_emotion=Negative
- agent_gender=$gender
Search for audio records where the gender of the agent has been identified as $gender. Possible values for $gender are
Female
andMale
. Only oneagent_gender
value can be used within a single search. For example:agent_gender=Female
- app.name=$appname and app.$category=$score
- Search for transcripts that have received the specified $score level from the analytics application $appname in the specified top- or lower-level category. To specify lower-level categories, use a full dot-separated path through the category tree. For example:
app.name=AgentScorecard app.Politeness=All app.$top_category.$lower_category.$lowest_category=Medium
$score may be one of the following values:
All
— Score greater than 0High
— Score greater than 0.66Medium
— Score greater than 0.33Low
— Score between 0 and 0.33None
— Score is 0
- client_clarity=$n-$m
Search for audio records with client voice clarity percentage within the range of N to M, which are floating point values. A score closer to 1 indicates higher clarity. Low clarity is the result of poor signal, background noise, accent, or poor enunciation. For example:
client_clarity=0.6-1.0
- client_emotion=$emotion
Search for audio records where the emotional score of the client's portion of the audio is $emotion. Possible values for $emotion are
Improving
,Negative
,Positive
, andWorsening
. Only oneclient_emotion
value can be used within a single search. For example:client_emotion=Improving
- client_gender=$gender
Search for audio records where the gender of the client has been identified as $gender. Possible values for $gender are
Female
andMale
. Only oneclient_gender
value can be used within a single search. For example:client_gender=Male
- daterange=$start-$end
-
Filters the request by the dates specified in the range [$start, $end]. Values for $start and $end are optional, but the hyphen between them is required.
The range specified by $start and $end may be expressed using any combination of years, months, days, hours, minutes, and seconds, expressed as YYYYMMDD[HHmmss]. Date ranges are always assumed to be positive (where $start is less than $end).
daterange
filters by values in the transcript record'sdatetime
field. Data for thedatetime
field is stored using the organization's time zone, which may vary by organization.No verification is done to ensure that
daterange
values are correct; invalid date ranges will simply return no values. If $start is not specified, a default value of 01 January, 1900 is used. If $end is not specified, the current date is used. - diarization=$score
Search for audio records with a diarization score of at least $score. which is a floating point value between 0 and 1. When mono (single-channel) audio has multiple speakers, diarization can separate the speakers for analysis. The diarization score identifies how completely the call was divided into individual speakers. A score of 2 means the call was not diarized. Diarization technology is not perfect, and to find calls where diarization is done well, set SCORE closer to one than to zero. The tradeoff is that fewer calls will be retrieved.
- duration=$n-$m
Search for audio records with duration in the range of $n to $m, where $n and $m are the minimum and maximum duration, respectively, of the audio records to be returned. Note the following:
The durations $n and $m can be expressed in the colon-delimited format
hh:mm:ss
.Only the seconds (
ss
) value is required; hours (hh
) and minutes (mm
) are optional.The colon delimiter is required only when specifying hours or minutes.
There is no limit to the numeric values of hours, minutes, or seconds.
Only the first value, $n, is required, along with the hyphen. A request with no value for $m returns results for all audio records with duration greater than the minimum value $n.
For example, to search for audio records with duration 30 minutes to 60 minutes, use any of the following:
duration=30:00-1:00:00 duration=30:00-60:00 duration=1800-3600
Similarly, any of the following expressions would return audio records at least 10 minutes long:
duration=10:00- duration=8:120- duration=6000-
- lastmodifiedrange=$start-$end
Filters the request by a record's
last_modified
value in the range of $start to $end. Data for thelast_modified
field is always stored using Coordinated Universal Time (UTC).Values for $start and $end are optional. The range specified by $start and $end may be expressed using any combination of years, months, days, hours, minutes, and seconds, expressed as YYYYMMDD[HHmmss]. Date ranges for
lastmodifiedrange
are always assumed to be positive (where $start is less than $end) and expressed in Coordinated Universal Time (UTC).Note: Records without a date and time value for thelast_modified
field are not included in results.- overall_emotion=$emotion
Search for audio records where the overall emotional score of the audio is $emotion. Possible values for $emotion are
Improving
,Negative
,Positive
, andWorsening
. Only oneoverall_emotion
value can be used within a single search. For example:overall_emotion=positive
- overall_gender=$gender
Search for audio records where the overall gender of the speakers has been identified as $gender. Possible values for $gender are
Female
andMale
. Only oneoverall_gender
value can be used within a single search. For example:overall_gender=Male
- overtalk=$n-$m
- Search for audio records with overtalk percentages within the range of $n to $m, which are floating point values. Overtalk occurs when speakers talk over one another. A recording's overtalk percentage is the count of agent-initiated overtalk turns as a percentage of the total number of agent speaking turns. In other words, out of all of the agent’s turns, overtalk measures how many agent turns interrupted a client’s turn. An overtalk value of 1 indicates the most overtalk. For example:
overtalk=0.2-0.6
- silence=$n-$m
- Search for audio records with silence percentages within the range of $n to $m, which are floating point values. Silence is equal to all non-speech time, as a percentage of the total audio duration. If music and noise are not decoded to word-events, they are counted as silence. Calls with a silence value of 1 contain the most silence. For example:
silence=0.2-0.5
- terms.$field=$value
Acceptable terms for $value vary by $field, which may be any of the following:
agent
agentid
client
file
requestid
speakers
tag
tid
$client_data
Acceptable terms for $client_data include any custom metdata field configured for the record's folder.
For example:
terms.agent=007
Include multiple terms in the value by using a comma-separated list. By default, multiple terms are combined with the
and
operator. To specify theor
operator, useterms.op
. For example:terms.agent=007,006
- terms.op=$operator
Define how multiple search terms should be logically combined. Acceptable values include
and
andor
, whereand
is the default operator. Ifand
is specified, the request returns only records that match both terms. Ifor
is specified, the request returns any record that matches either term. For example:terms.tid=1,2&terms.op=or