Get a rule
Retrieve a rule by ID.
rule_set_id, its position in that set (order), condition, actions, description, stop_after_match, time window settings, and status.
If the rule has budgets configured, the response includes the current budget state for each asset: consumed amount and next_reset_at timestamp. This is the primary way to check how much of a rule’s budget has been spent. To reset a budget manually, use the reset budget endpoint.
Authorizations
API key passed in the X-API-Key header.
Path Parameters
Rule ID
Response
Rule details
Actions to execute when the condition matches
Start of the rule's active window (RFC 3339, null if always active). Checked against the event's event_timestamp, inclusive.
"2024-01-01T00:00:00Z"
End of the rule's active window (RFC 3339, null if no end date). Checked against the event's event_timestamp, exclusive.
"2024-12-31T23:59:59Z"
Budget constraints applied to this rule
CEL expression that determines when the rule fires
"event.type == 'purchase' && event.amount > 0"
When this rule was created (RFC 3339)
"2024-01-15T10:30:00Z"
When this rule was archived (null if not archived)
"2024-06-01T00:00:00Z"
Human-readable summary of what this rule does
"Awards 10 points per dollar spent"
Unique identifier for this rule
"550e8400-e29b-41d4-a716-446655440000"
Display name
"Purchase Reward"
Evaluation position within the containing rule set (lower = first; ACTIVE and SUSPENDED rules occupy unique positions)
1
Program this rule belongs to
"550e8400-e29b-41d4-a716-446655440001"
Resulting program rule-configuration revision. Present on mutation responses.
4
Rule set that contains this rule and scopes its order and stop_after_match behavior
"550e8400-e29b-41d4-a716-446655440002"
Lifecycle status: ACTIVE, SUSPENDED, or ARCHIVED
"ACTIVE"
When true, no subsequent rules in this set evaluate after this one matches; other sets continue
false
When this rule was last modified (RFC 3339)
"2024-01-15T10:30:00Z"
Non-blocking advisories about the rule's condition or action expressions, such as unknown state-key typos or deprecated CEL aliases. Present on create/update only; never blocks the save.