younifyd
Menu

Describe Search Index

Learn what a search index contains: its fields, the values you can filter on, price ranges and segments

Use it in a workflow

  1. Add a step and choose the Search connector.
  2. Pick the Describe Search Index action (under database).
  3. Fill in the fields below, then reference the result from later steps as {{describeSearchIndex.response.data}}.

Fields

indexSlugstringrequired

The search index to use, by slug. Can also be a variable, e.g. {{variables.indexSlug}}.

accessTokensstring

Comma-separated groups the visitor belongs to. Values from documents restricted to other groups are left out.

Examples

Describe the products index

Returns fields, valid values, segments and a guide

json
{
  "indexSlug": "products"
}

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