Skip to main content
POST
Analyze rule-set interactions and configuration impact
Analyzes how rules interact in the current configuration, or in a complete proposed configuration. Read-only. Send {} to analyze the current revision. To analyze a draft, pass proposed_configuration in the same shape as configuration preview. The analysis validates the draft. It does not create a preview or change the live version. Each finding includes a stable code, severity, confidence, the implicated rules or rule_sets, expression or action path, runtime_semantics, and remediation. The response also returns grounding and limits. Findings are advisory. They do not mean two conditions will match the same event. See Check a draft.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

programId
string<uuid>
required

Program ID

Body

application/json

Current ({}) or proposed configuration analysis request

focus
object

Limit findings to those involving at least one selected rule set, rule, or client reference.

proposed_configuration
object

Complete configuration to check, in the same shape accepted by the preview endpoint. Omit to check the current configuration.

Response

OK

active_rule_count
integer

ACTIVE rules participating in runtime interaction analysis.

base_rule_configuration_version
integer

Current configuration version used as the basis for the analysis.

configuration_hash
string

Stable SHA-256 hash of the analyzed current configuration or normalized proposal.

finding_count
integer

Number of findings returned.

findings
object[]

Potential issues and suggested fixes, in a stable order.

grounding
object

Which event field checks the analysis performed.

limits
object

Complexity and response limits applied by the server.

program_id
string<uuid>

Program whose configuration was analyzed.

rule_count
integer

Total ACTIVE and SUSPENDED rules in the analyzed configuration.

source
enum<string>

Configuration source: current or proposed.

Available options:
current,
proposed
truncated
boolean

True when the response limit prevented some findings from being returned.