Get userID
$client->getUserId(string userID)
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.
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
Read the Algolia CLI documentation for more information.
Get userID
1
$client->getUserId('myUserID1');
Parameters
Parameter | Description |
---|---|
userID
|
type: string
Required
userID to fetch. |
Response
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 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. |