Skip to content

support_rule_list

List this product’s delivery rules, newest first.

Tool

support_rule_list

List this product’s delivery rules, newest first.

List this product’s delivery rules, newest first. Supply surveyId or enabled to filter by survey or live state; omit both to include all surveys and both states. Supply url to match a page and device to match its device type. With url but no device, only rules targeting any device match; omit both to skip page and device matching. The client runtime reads the public edge, which requires url and returns only live rules on published surveys.

Behavior

HTTP
GET /support/rules

Arguments

Name
Type
Required
Description
url
string
—
Only rules whose URL match applies to this page URL
limit
integer
—
Page size, 1..100 (default 25)
device
string
—
The device the page is rendered on. Without it only rules targeting any device match
offset
integer
—
Number of rules to skip
enabled
boolean
—
true: only live rules. false: only switched-off ones
surveyId
string
—
Only rules delivering this survey

Response

Field
Type
Always
Description
limit
integer
•
Page size that was applied
rules
array
•
The requested page of rules, newest first
offset
integer
•
Offset that was applied

Try it

List this product’s delivery rules, newest first.

When to use

List this product’s delivery rules, newest first. Supply surveyId or enabled to filter by survey or live state; omit both to include all surveys and both states. Supply url to match a page and device to match its device type. With url but no device, only rules targeting any device match; omit both to skip page and device matching. The client runtime reads the public edge, which requires url and returns only live rules on published surveys.

Example

Ask your agent something like this:

List this product’s delivery rules, newest first.

The agent will invoke support_rule_list with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select