RErecombee
Segmentations Definition

Create Auto ReQL Segmentation

Segment the items using a ReQL expression.

For each item, the expression should return a set that contains IDs of segments to which the item belongs to.

put/{databaseId}/segmentations/auto-reql/{segmentationId}

Request

  • Base URL
    http://Based on the region of your database (see https://docs.recombee.com/regions).
  • URL
    http://Based on the region of your database (see https://docs.recombee.com/regions)./{databaseId}/segmentations/auto-reql/{segmentationId}
  • Auth
    none declared

Path parameters

databaseIdstring required

ID of your database.

segmentationIdstring required

ID of the newly created Segmentation

Request body

sourceTypestring required

What type of data should be segmented. Currently only items are supported.

expressionstring required

ReQL expression that returns for each item a set with IDs of segments to which the item belongs

titlestring

Human-readable name that is shown in the Recombee Admin UI.

descriptionstring

Description that is shown in the Recombee Admin UI.

Response

successful operation

Changes

No recorded changes to this operation across all 3 revisions of this API.