GET
/
experience-manager
/
rules
/
{ruleId}
Get a rule
curl --request GET \
  --url https://{FUSION HOST}/api/experience-manager/rules/{ruleId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "campaign_id": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deployed": true,
  "description": "<string>",
  "display_type": "<string>",
  "doc_type": "<string>",
  "effective_range": [
    "<string>"
  ],
  "filters": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "groups": "<string>",
  "id": "<string>",
  "matching": "keywords",
  "name": "<string>",
  "priority": 123,
  "query_profile_id_ss": [
    "<string>"
  ],
  "response_values": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "review": "approved",
  "rollup": "<string>",
  "search_terms": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "target_segments": [
    "<string>"
  ],
  "updatedOn": "2023-11-07T05:31:56Z",
  "variant_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
ruleId
string
required

Unique identifier of the rule to retrieve.

Query Parameters

​
context
string
required

Application context for retrieving the rule.

​
staging
boolean
required

Indicates whether to retrieve the rule from a staging environment.

Response

Rule retrieved successfully.

Represents the response containing details of a rule in the Experience Manager.

​
campaign_id
string

Unique identifier of the campaign associated with this rule.

​
createdOn
string<date-time>

Timestamp indicating when the rule was created.

​
deployed
boolean

Indicates whether the rule is currently deployed.

​
description
string

A brief description of the rule.

​
display_type
string

The display type associated with the rule.

​
doc_type
string

The document type of the rule response.

​
effective_range
string[]

Defines the time range during which the rule is active.

​
filters
object[]

A list of filter conditions for applying the rule.

​
groups
string

User groups associated with this rule.

​
id
string

Unique identifier for the rule.

​
matching
enum<string>

Defines the matching criteria for the rule.

Available options:
keywords,
phrase,
text
​
name
string

The name of the rule.

​
priority
integer

Defines the priority level of the rule.

​
query_profile_id_ss
string[]

A list of query profile IDs associated with this rule.

​
response_values
object[]

A list of response values applied by the rule.

​
review
enum<string>

The review status of the rule.

Available options:
approved,
auto,
denied,
pending,
supplied
​
rollup
string

The rollup strategy applied to the rule.

​
search_terms
string[]

A list of search terms associated with the rule.

​
tags
string[]

A list of tags associated with the rule.

​
target_segments
string[]

A list of unique target segments for the rule.

​
updatedOn
string<date-time>

Timestamp indicating when the rule was last updated.

​
variant_id
string

Unique identifier for the variant of this rule.