List userIDs
This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.
This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.
This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.
This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.
This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.
This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.
This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.
This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.
This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.
This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.
Required API Key: Admin
$client->listUserIds() $client->listUserIds([ // All the following parameters are optional 'page' => integer , 'hitsPerPage' => integer ])
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
1
2
3
4
$client->listUserIds([
'page' => 0,
'hitsPerPage' => 20,
]);
Parameters
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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"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. |