Skip to main content
GET
/
em-rules
/
{id}
Get a rule
import requests

url = "https://{commerce_studio_id}.experiencemanager.lucidworks.com/em-rules/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "type": "BANNER",
  "additionalProperties": {},
  "conditionType": "SEARCH",
  "conditions": {
    "queries": [
      "shirts",
      "pants"
    ],
    "fieldValues": [
      {
        "field": "category",
        "value": "Shirts",
        "name": "example_field"
      }
    ],
    "queryProfiles": [
      "MyQueryProfile"
    ],
    "effectiveStart": "2023-11-07T05:31:56Z",
    "effectiveEnd": "2023-11-07T05:31:56Z"
  },
  "conflicts": [
    {
      "targetedDocumentGroups": [
        {
          "id": "doc1"
        },
        {
          "id": "doc2"
        }
      ],
      "targetedDocumentsErrorMessage": "<string>",
      "targetedDocumentsQueryUrl": "<string>",
      "targetedDocumentsFormParams": {},
      "targetedDocumentsBody": {
        "stageOverrides": {},
        "executionModifiers": {
          "rules.suppressed": {
            "9d6b8d0d-802b-4563-8d5f-ce26de91802b": true,
            "8d6b8d0d-802b-4563-8d5f-ce26de91802b": true,
            "36b173ca-02f7-456f-9f4a-070d9d028b96": true
          }
        },
        "params": {}
      },
      "fieldName": "title_s",
      "fieldValues": [
        "value1",
        "value2"
      ],
      "termsQuerySeparator": ",",
      "termsQueryMethod": "termsFilter",
      "blockGroupsList": [
        {
          "blockGroups": [
            {
              "blocks": [
                {
                  "field": "brand",
                  "operator": "EQUAL",
                  "value": "nike"
                }
              ],
              "operator": "OR"
            }
          ],
          "boostFactor": 1
        }
      ]
    }
  ],
  "createdBy": "<string>",
  "creationDate": "2023-11-07T05:31:56Z",
  "deleted": true,
  "description": "<string>",
  "externalId": "<string>",
  "groups": [
    "<string>"
  ],
  "hasConflicts": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastModified": "2023-11-07T05:31:56Z",
  "lastModifiedBy": "<string>",
  "liveFusionSyncStatus": {
    "version": "2023-11-07T05:31:56Z",
    "lastSyncedVersion": "2023-11-07T05:31:56Z",
    "fusionVersion": "<string>"
  },
  "markedForDeletion": true,
  "matchSearchQueryUsing": "KEYWORDS",
  "migratedId": "<string>",
  "migration": {
    "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceEmInstanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceBulkOperationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "name": "<string>",
  "pendingBulkOperation": true,
  "precedence": 123,
  "publishState": "DRAFT",
  "published": true,
  "responseValues": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "segments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdBy": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>",
      "lastModified": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "value": "<string>",
      "type": "<string>",
      "ruleCount": 123
    }
  ],
  "stagingContent": "<unknown>",
  "stagingFusionSyncStatus": {
    "version": "2023-11-07T05:31:56Z",
    "lastSyncedVersion": "2023-11-07T05:31:56Z",
    "fusionVersion": "<string>"
  },
  "tags": [
    "<string>"
  ],
  "url": "<string>",
  "zone": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

The rule's Universally-Unique Identifier (UUID). You can also use the externalId, if the rule has one.

Query Parameters

​
fields
enum<string>[]

Optional additional fields to include in the response. Keep in mind that additional fields can slow the call and increase the response size.

Available options:
TARGETED_DOCUMENTS,
CONFLICTS,
IS_PENDING_BULK_OPERATION,
FUSION_SYNC_STATUS,
MIGRATION

Response

OK

Displays a banner in the search results when rule criteria match.

​
type
enum<string>
required

Rule type. Determines which schema applies.

Available options:
BANNER
​
additionalProperties
object

Optional additional properties.

​
conditionType
enum<string>

Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within stagingContent.

Available options:
SEARCH,
CATEGORY
​
conditions
ConditionsSummary · object

Conditions for the rule.

​
conflicts
(BlockByAttributeRuleSummary · object | BlockListRuleSummary · object | BoostAttributesRuleSummary · object | BoostListRuleSummary · object | BuryAttributesRuleSummary · object | BuryListRuleSummary · object | FilterListRuleSummary · object | InGroupBoostListRuleSummary · object | InGroupBuryListRuleSummary · object | InGroupPinRuleSummary · object | JsonBlobRuleSummary · object | PinRuleSummary · object | RedirectRuleSummary · object | any | SetJSONFacetsRuleSummary · object | SetParamsRuleSummary · object)[]

Rules with conflicting/overlapping conditions.

Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, Color) and list of values to block.

​
createdBy
string

User who created the entity.

​
creationDate
string<date-time>

Date when the entity was created.

​
deleted
boolean

Mark the rule as deleted without fully removing it from the system (if this is true or markedForDeletion is true). Unlike markedForDeletion, this is a writeable field.

​
description
string

A rule description.

​
externalId
string

An optional ID set by external users of the API at creation time. Cannot be changed after creation.

​
groups
string[]

A method of rule organization. Rules can be part of multiple rule groups.

​
hasConflicts
boolean

It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance.

​
id
string<uuid>

Entity ID.

​
lastModified
string<date-time>

Date when the entity was last updated.

​
lastModifiedBy
string

User who last updated the entity.

​
liveFusionSyncStatus
FusionSyncStatusSummary · object

Status of this rule's (staging or live contents) synchronization.

​
markedForDeletion
boolean

This is true if this rule is marked for deletion (deleted is true) but has not yet been fully removed from the system. This is only true in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (true) do not appear in the listing endpoints (other than GET by ID) unless explicitly requested to be included.

​
matchSearchQueryUsing
enum<string>
default:KEYWORDS

Defines how the specified search terms will be compared to the user's query to determine whether this rule applies.

Available options:
KEYWORDS,
TEXT,
PHRASE,
STARTS_WITH,
ENDS_WITH
Example:

"KEYWORDS"

​
migratedId
string

If this was originally migrated from another system, this field shows the ID of the original rule.

​
migration
MigrationSummary · object

Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another.

​
name
string

Entity name.

​
pendingBulkOperation
boolean

Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to false.

​
precedence
integer<int32>

Specifies the rule's precedence when multiple rules could apply to the same query.

Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2.

If two rules have the same precedence, the more recently created rule takes precedence.

​
publishState
enum<string>

The publish state of the rule: DRAFT (unpublished), PUBLISHED (published with no staged changes), or PUBLISHED_WITH_DRAFT_EDITS (published but with pending changes in staging).

Available options:
DRAFT,
PUBLISHED,
PUBLISHED_WITH_DRAFT_EDITS
​
published
boolean

Whether the rule is staged or published.

​
responseValues
KeyValueSummary · object[]

A list of key-value pairs representing response values.

​
segments
SegmentSummary · object[]

The segments that this rule will apply to.

​
stagingContent

A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment.

​
stagingFusionSyncStatus
FusionSyncStatusSummary · object

Status of this rule's (staging or live contents) synchronization.

​
tags
string[]

A set of short, descriptive labels for categorization or quick reference.

​
url
string

Banner rule URL.

​
zone
string

Banner rule zone.