support_rule_get

Tool

Get one delivery rule by id, with its whole configuration.

Get one delivery rule by id, with its whole configuration. A rule belonging to another product is reported as not found

Name	Type	Required	Description
id	string	•	Rule id

Field	Type	Always	Description
id	string	•	Rule id
device	string	•	Which devices the rule applies to. any is the rule that does not care and is the default
enabled	boolean	•	Whether the rule is live
trigger	object	•	When the client’s runtime shows the survey once the page matches: immediately, after a delay, or on an event of its own
surveyId	string	•	The survey this rule delivers
urlMatch	object	•	Which pages match
createdAt	string	•	ISO-8601 creation timestamp
frequency	object	•	How often the same person may see this survey. The client’s runtime enforces it — this toolkit never sees the end user
updatedAt	string	•	ISO-8601 last-modification timestamp
attributeConditions	array	•	Conditions on the visitor’s attributes, ALL of which must hold

Get one delivery rule by id, with its whole configuration.

When to use

Get one delivery rule by id, with its whole configuration. A rule belonging to another product is reported as not found

Ask your agent something like this:

Get one delivery rule by id, with its whole configuration.

The agent will invoke support_rule_get with these arguments:

{
  "id": "<id>"
}