API Reference / API Methods / MultiClusters / Get top userID
Feb. 26, 2019

Get top userID

Required API Key: Admin
Method signature
$client->getTopUserId()

About this method

Get the top 10 userIDs with the highest number of records per cluster.

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

Get the top userIDs

1
$client->getTopUserId();

Parameters

No parameters for this method.

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "topUsers": {
    "c10-test": [
      {
        "userID": "user1",
        "nbRecords": 104,
        "dataSize": 17400
      {
        "userID": "user2",
        "nbRecords": 18,
        "dataSize": 3195
      }

    ],
    "c11-test": [
      {
        "userID": "user3",
        "nbRecords": 104,
        "dataSize": 17400
      },
      {
        "userID": "user4",
        "nbRecords": 1,
        "dataSize": 72
      }
    ]
  }
}
topUsers
key value mapping

Mapping of cluster names to top users.

User info object

userID
string

UserID of the user.

nbRecords
integer

Number of records belonging to the user.

dataSize
integer

Data size taken by the user.

Did you find this page helpful?