Skip to main content
GET
Get Rule

Authorizations

Authorization
string
header
required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

rule_id
integer
required

ID of the rule

agent_id
string
required

Tuner's numeric agent ID, or your Agent ID from Agent Settings > Agent Connection. Digits-only values are read as the numeric ID.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Response

Successful Response

Response schema for a rule.

id
integer
required

Tuner's ID for this rule.

output_type
string
required

Whether matching calls get a label or a red flag.

output_tag_name
string
required

Tag applied to matching calls.

state
string
required

active when the rule runs on new calls, paused when it doesn't.

Example:

"active"

created_at
string<date-time>
required

When the rule was created.

updated_at
string<date-time>
required

When the rule was last updated.

condition_tree
Condition Tree · object | null

The rule's conditions: a group of predicates and nested groups, in the format condition_tree takes when you create or update a rule. For an eval, a voice metric or a data extraction field, lhs is the item's current name. null only for an older rule whose condition could not be converted; it never matches.

Example:
output_description
string | null

Note explaining what this rule is for.

paused_reason
string | null

Why Tuner paused this rule, such as Eval deleted when the eval its condition used was deleted. Null when it is active or a person paused it.

Example:

null