Package recombee_api_client :: Package api_requests :: Module list_users :: Class ListUsers
[hide private]
[frames] | no frames]

Class ListUsers

source code

     object --+    
              |    
request.Request --+
                  |
                 ListUsers

Gets a list of IDs of users currently present in the catalog.

Instance Methods [hide private]
 
__init__(self, filter=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), count=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), offset=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), return_properties=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), included_properties=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'))
Optional parameters:
source code
 
get_body_parameters(self)
Values of body parameters as a dictionary (name of parameter: value of the parameter).
source code
 
get_query_parameters(self)
Values of query parameters as a dictionary (name of parameter: value of the parameter).
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from request.Request: quote_path_param

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, filter=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), count=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), offset=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), return_properties=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'), included_properties=UUID('eb39e9ae-84f4-49c9-992c-60da116bca57'))
(Constructor)

source code 

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:

    ```

    [

    {

    "userId": "user-81",

    "country": "US",

    "sex": "M" },

    {

    "userId": "user-314",

    "country": "CAN",

    "sex": "F" }

    ]

    ```

  • 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`:

    ```

    [

    {

    "userId": "user-81",

    "country": "US" },

    {

    "userId": "user-314",

    "country": "CAN" }

    ]

    ```

Overrides: object.__init__