List userIDs

Required API Key: Admin

Method signature

$client->listUserIds()

$client->listUserIds([
  // All the following parameters are optional
  'page' => integer ,
  'hitsPerPage' => integer
])

client.list_user_ids(Hash opts = {
  Integer page: 0
  Integer hitsPerPage: 20
})

client.listUserIDs()

client.listUserIDs({
  // All the following parameters are optional
  page: integer,
  hitsPerPage: integer
})

client.list_user_ids()

client.list_user_ids({
    // All the following parameters are optional
    'page': int,
    'hitsPerPage': int
})

client.listUsers(
  page: Int? = nil,
  hitsPerPage: Int? = nil,
  requestOptions: RequestOptions? = nil,
  completion: Result<UserIDListResponse> -> Void
)

suspend fun ClientSearch.listUserIDs(
    page: Int? = null,
    hitsPerPage: Int? = null,
    requestOptions: RequestOptions? = null
): ResponseListUserIDs

client.ListUserIDs(
  // All the following parameters are optional
  page: int,
  hitsPerPage: int
)

client.listUserIDs(
  // All the following parameters are optional
  page: int,
  hitsPerPage: int
)

client.ListUserIDs()
client.ListUserIDs(
  // All the following parameters are optional
  opt.Page(page: int),
  opt.HitsPerPage(hitsPerPage: int),
)

This method is not yet available in the scala api client.

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

List the userIDs assigned to a multi-clusters appID.

The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters.

Examples

Read the Algolia CLI documentation for more information.

List userId

Copy

1
2
3
4
$client->listUserIds([
  'page' => 0,
  'hitsPerPage' => 20,
]);

Parameters

Parameter	Description
`page`	type: integer default: 0 Optional Page to fetch.
`hitsPerPage`	type: integer default: 20 Optional Number of users to retrieve per page.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

          {
  "userIDs": [
    {
      "userID": "user1",
      "clusterName": "c11-test",
      "nbRecords": 118,
      "dataSize": 21055
    },
    {
      "userID": "user2",
      "clusterName": "c11-test",
      "nbRecords": 3,
      "dataSize": 650
    }
  ],
  "page": 0,
  "hitsPerPage": 20
}

        

Field	Description
`userIDs`	list of user object
`page`	integer Page which has been requested.
`hitsPerPage`	integer Number of hits per page requested.

userIDs ➔ user object

Field	Description
`userID`	string Unique userID.
`clusterName`	string Cluster on which the user is assigned.
`nbRecords`	integer Number of records belonging to the user.
`dataSize`	integer Data size used by the user.

Did you find this page helpful?