API client / Methods / MultiClusters
Required API Key: Admin
Method signature
$client->getUserId(string userID)

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

About this method # A

Returns the userID data stored in the mapping.

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 # A

Get userID#

1
$client->getUserId('myUserID1');

Parameters # A

Parameter Description
userID #
type: string
Required

userID to fetch.

Response # A

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
{
  "userID": "user4",
  "clusterName": "c10-test",
  "nbRecords": 104,
  "dataSize": 17400
}
Field Description
userID #
string

userID of the requested user.

clusterName #
string

Cluster on which the user data is stored.

nbRecords #
integer

Number of records on the cluster.

dataSize #
integer

Data size used on the cluster.

Did you find this page helpful?
PHP v3