younifyd
Menu

Get Search Profile

Get search profile

GET/pcm/catalogs/search-profiles/{search_profile_id}

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Search Profile action (under Catalog Search).
  3. Fill in the fields below, then reference the result from later steps as {{getSearchProfile.response.data}}.

Request

Path parameters

search_profile_idstring (uuid)required

The unique ID of the search profile

search_profile_idstringrequired

The unique ID of the search profile or 'default' to retrieve the default search profile.

Response

Returns 200 with an object. Read it in later steps with {{getSearchProfile.response.data.<field>}}.

dataobject
idstring (uuid)required

The unique identifier for the search profile.

typestringrequired

Represents the type of object being returned. Always `catalog_search_profile`.

One ofcatalog_search_profile

attributesobjectrequired12 fields
metaobjectrequired2 fields
json
{
  "data": {
    "id": "805103ff-0a37-4f83-8fe0-95a16039bd98",
    "type": "catalog_search_profile",
    "attributes": {
      "slug": "default",
      "description": "Default search profile",
      "fields": [
        {
          "name": "name",
          "weight": 10,
          "num_typos": 1,
          "prefix": true
        }
      ],
      "force_use_default_price_for_faceting_and_sorting": true,
      "text_match_type": "max_score",
      "filters": [
        "meta.search.categories.lvl1:=`All Products > Mens Shoes`"
      ],
      "exclusions": [
        "meta.search.categories.lvl1:=`All Products > Mens Shoes`"
      ],
      "boosts": [
        {
          "condition": "meta.search.nodes.name:=\\`Electronics\\`",
          "weight": 5
        }
      ],
      "prefix": true,
      "typo_tolerance": {
        "num_typos": 1,
        "min_len_to_allow_single_character_correction": 3,
        "min_len_to_allow_two_character_correction": 7,
        "typo_tokens_threshold": 1,
        "drop_tokens_threshold": 1,
        "drop_tokens_mode": "right_to_left",
        "enable_typos_for_numerical_tokens": true,
        "enable_typos_for_special_char_tokens": true,
        "split_join_tokens": "fallback"
      },
      "synonym_settings": {
        "demote_synonym_match": true,
        "synonym_resolution_allowed_on_prefix": true,
        "number_of_typos_allowed_when_resolving_synonyms": 0
      },
      "synonym_sets": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    },
    "meta": {
      "default": true,
      "owner": "organization"
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.