Get UserID | iOS API Client V7 (Deprecated)

Deprecated content

This documentation is for a deprecated version of iOS API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of iOS API client for up-to-date information.

Required API Key: Admin

Method signature

This method is not yet available in the swift api client.

See code examples

About this method

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

Get userID

Copy

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

Parameters


            userID

type: string

Required

userID to fetch.

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

        {
  "userID": "user4",
  "clusterName": "c10-test",
  "nbRecords": 104,
  "dataSize": 17400
}

`userID`	string userID of the requested user.
`clusterName`	string Cluster on which the data of the user is stored.
`nbRecords`	integer Number of records this user has on the cluster.
`dataSize`	integer Data size taken by this user on the cluster.

Did you find this page helpful?