Skip to content

Support

support_rule_list

List this product’s delivery rules, newest first, optionally narrowed to one survey, to the live or switched-off ones, or to the rules that apply to a given page URL and device.

Tool

support_rule_list

List this product’s delivery rules, newest first, optionally narrowed to one survey, to the live or switched-off ones, or to the rules that apply to a given page URL and device.

List this product’s delivery rules, newest first, optionally narrowed to one survey, to the live or switched-off ones, or to the rules that apply to a given page URL and device. This is the same answer a client’s runtime fetches through the public edge, where a URL is required and only live rules on published surveys are visible

Behavior

HTTP
GET /support/rules

Arguments

NameTypeRequiredDescription
urlstringOnly rules whose URL match applies to this page URL
limitintegerPage size, 1..100 (default 25)
devicestringThe device the page is rendered on. Without it only rules targeting any device match
offsetintegerNumber of rules to skip
enabledbooleantrue: only live rules. false: only switched-off ones
surveyIdstringOnly rules delivering this survey

Response

FieldTypeAlwaysDescription
limitintegerPage size that was applied
rulesarrayThe requested page of rules, newest first
offsetintegerOffset that was applied

Try it

List this product’s delivery rules, newest first, optionally narrowed to one survey, to the live or switched-off ones, or to the rules that apply to a given page URL and device.

When to use

List this product’s delivery rules, newest first, optionally narrowed to one survey, to the live or switched-off ones, or to the rules that apply to a given page URL and device. This is the same answer a client’s runtime fetches through the public edge, where a URL is required and only live rules on published surveys are visible

Example

Ask your agent something like this:

List this product’s delivery rules, newest first, optionally narrowed to one survey, to the live or switched-off ones, or to the rules that apply to a given page URL and device.

The agent will invoke support_rule_list with these arguments:

{}

Esc

Start typing to search the docs.

navigateselect