Sign in

v1

latestOpenAPI 3.0.3GPL-3.02026-07-177978150.2 KB
curation_sets

Retrieve a curation set item

Retrieve a specific curation item by its id

get/curation_sets/{curationSetName}/items/{itemId}

Path parameters

curationSetNamestring required

The name of the curation set

itemIdstring required

The id of the curation item to retrieve

Response

Curation item fetched

filter_bystring

A filter by clause that is applied to any search query that matches the curation rule.

remove_matched_tokensboolean

Indicates whether search query tokens that exist in the curation's rule should be removed from the search query.

metadataobject

Return a custom JSON object in the Search API response, when this rule is triggered. This can can be used to display a pre-defined message (eg: a promotion banner) on the front-end when a particular rule is triggered.

sort_bystring

A sort by clause that is applied to any search query that matches the curation rule.

replace_querystring

Replaces the current search query with this value, when the search query matches the curation rule.

filter_curated_hitsboolean

When set to true, the filter conditions of the query is applied to the curated records as well. Default: false.

effective_from_tsinteger

A Unix timestamp that indicates the date/time from which the curation will be active. You can use this to create rules that start applying from a future point in time.

effective_to_tsinteger

A Unix timestamp that indicates the date/time until which the curation will be active. You can use this to create rules that stop applying after a period of time.

stop_processingboolean

When set to true, curation processing will stop at the first matching rule. When set to false curation processing will continue and multiple curation actions will be triggered in sequence. Curations are processed in the lexical sort order of their id field.

idstring required

ID of the curation item