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
agent_id
integer
required

Tuner's internal numeric ID for the agent.

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.

condition_source_type
string
required

Category of call data the condition tests.

condition_source_id
integer
required

ID of the eval, metric, or field the condition tests.

operator
string
required

How the value is compared.

condition_value
any
required

Value the condition compares against.

output_type
string
required

Whether matching calls get a label or a red flag.

output_tag_name
string
required

Tag applied to matching calls.

created_at
string<date-time>
required

When the rule was created.

updated_at
string<date-time>
required

When the rule was last updated.

condition_source_name
string | null

Display name of the referenced eval, metric, or field.

output_description
string | null

Note explaining what this rule is for.