API Reference / API Methods / MultiClusters / Get top userID
Required API Key: Admin
Method signature
$client->getTopUserIds()

About this method

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.

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

Read the Algolia CLI documentation for more information.

Get the top userIDs

1
$client->getTopUserIds();

Parameters

This method doesn't take any parameters.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

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?