RErecombee
Segmentations Definition

Create Property Based Segmentation

Creates a Segmentation that splits the items into segments based on values of a particular item property.

A segment is created for each unique value of the property. In case of set properties, a segment is created for each value in the set. Item belongs to all these segments.

put/{databaseId}/segmentations/property-based/{segmentationId}

Request

  • Base URL
    http://Based on the region of your database (see https://docs.recombee.com/regions).
  • 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.

propertyNamestring required

Name of the property on which the Segmentation should be based

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.