Feb. 26, 2019
List UserIDs
Required API Key:
Admin
Method signature
$client->listUserIds() $client->listUserIds([ // All the following parameters are optional 'page' => integer , 'hitsPerPage' => integer ])
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
List userId
Copy
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
In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.
JSON format
Copy
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
}
userIDs
|
list of user object
|
page
|
integer
Page which has been requested. |
hitsPerPage
|
integer
Number of hits per page requested. |
userIDs âž” user object
userID
|
string
userID of the user. |
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. |
