Skip to content

Commit 1036a39

Browse files
authored
Added segment parameters (#2269)
1 parent 1c19fcb commit 1036a39

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/personalization/api_reference/recommendation_api.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,17 @@ For more information, see [Submodels]([[= user_doc =]]/personalization/recommend
8787

8888
`GET https://reco.perso.ibexa.co/api/v2/00000/john.doe/landing_page.json?numrecs=50&outputtypeid=1&width-range=10:30&color=green`
8989

90+
##### Segment parameters
91+
92+
If you have configured segments, you can use them in the recommendation model. Pass the following parameter
93+
to request recommendations for a specific segment or segment group.
94+
95+
Parameter|Example|Description|Value|
96+
|---|---|---|---|
97+
|`segments`|`&segments=7,8,10,11`|ID from segment group management|string|
98+
99+
For more information, see [Segments]([[= user_doc =]]/personalization/segment_management).
100+
90101
## Responses
91102

92103
The recommendation request returns information about the currently used context

0 commit comments

Comments
 (0)