recombee_api_client.api_requests.list_users module¶
-
class
recombee_api_client.api_requests.list_users.
ListUsers
(filter: str = UUID('369f1a69-b90d-41c7-b23a-64b91cb5e0b1'), count: int = UUID('369f1a69-b90d-41c7-b23a-64b91cb5e0b1'), offset: int = UUID('369f1a69-b90d-41c7-b23a-64b91cb5e0b1'), return_properties: bool = UUID('369f1a69-b90d-41c7-b23a-64b91cb5e0b1'), included_properties: list = UUID('369f1a69-b90d-41c7-b23a-64b91cb5e0b1'))¶ Bases:
recombee_api_client.api_requests.request.Request
Gets a list of IDs of users currently present in the catalog.
Optional parameters:
- Parameters
filter – Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is true will be returned.
count – The number of users to be listed.
offset – Specifies the number of users to skip (ordered by userId).
return_properties – With returnProperties=true, property values of the listed users are returned along with their IDs in a JSON dictionary.
Example response:
[
E{lb}
“userId”: “user-81”,
“country”: “US”,
“sex”: “M” E{rb},
E{lb}
“userId”: “user-314”,
“country”: “CAN”,
“sex”: “F” E{rb}
]
- Parameters
included_properties – Allows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list.
Example response for includedProperties=country:
[
E{lb}
“userId”: “user-81”,
“country”: “US” E{rb},
E{lb}
“userId”: “user-314”,
“country”: “CAN” E{rb}
]
-
get_body_parameters
() → dict¶ Values of body parameters as a dictionary (name of parameter: value of the parameter).
-
get_query_parameters
() → dict¶ Values of query parameters as a dictionary (name of parameter: value of the parameter).