Search UserID | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

client.searchUserIDs({
  query: string query,
  cluster: string clusterName,
  page: integer page,
  hitsPerPage: integer hitsPerPage,
}, callback)

About this method

Search for userIDs.

The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds propagate to the different clusters.

To keep updates moving quicky, the index of userIDs isn’t built synchronously with the mapping. Instead, the index is built once every 12h, at the same time as the update of userID usage. For example, when you perform a modification like adding or moving a userID, the search will report an outdated value until the next rebuild of the mapping, which takes place every 12h.

Examples

Search userID

1
2
3
4
5
6
7
8
9
$page = 0;
$hitsPerPage = 12;

$client->searchUserIds('query', [
  // All the following parameters are optional
  'clusterName' => 'c1-test',
  'page' => $page,
  'hitsPerPage' => $hitsPerPage,
]);

1
2
3
page = 0
hits_per_page = 12
client.search_user_ids('query', 'c1-test', page, hits_per_page)

1
2
3
4
5
6
7
8
9
10
client.searchUserIDs({
  query: 'query',
  cluster: 'c1-test',
  page: 0,
  hitsPerPage: 12,
}, (err, content) => {
  if (err) throw err;

  console.log(content);
});

1
2
3
4
5
6
client.search_user_ids({
    'query': 'query',
    'cluster': 'c1-test',
    'page': 0,
    'hitsPerPage': 12,
})

1
2
3
4
5
int page = 0, hitsPerPage = 12
var res = client.SearchUserIds("query", "c1-test", page, hitsPerPage);

// Asynchronous
var res = await client.SearchUserIdsAsync("query", "c1-test", page, hitsPerPage);

1
2
3
4
5
int page = 0, hitsPerPage = 12;
SearchResult<UserId> res = client.searchUserIDs("query", "c1-test", page, hitsPerPage);

// Asynchronous
SearchResult<UserId> res = client.searchUserIDsAsync("query", "c1-test", page, hitsPerPage);

1
2
3
4
5
6
res, err := client.SearchUserIDs(
    "query",
    opt.Cluster("c1-test"),
    opt.Page(0),
    opt.HitsPerPage(12),
)

1
2
3
client.execute {
  search userIDs "query" cluster "c1-test" page 0 hitsPerPage 12
}

$
$
$
$
$
$
curl -X POST \
     -H "X-Algolia-API-Key: ${API_KEY}" \
     -H "X-Algolia-Application-Id: ${APPLICATION_ID}" \
     --data-binary "{ \
     \"query\": \"user1\", \"cluster\":\"c1-test\"}" \
    "https://${APPLICATION_ID}.algolia.net/1/clusters/mapping/search"

1
2
3
4
5
6
7
val query = UserIDQuery(
    query = "query",
    clusterName = ClusterName("c1-test"),
    hitsPerPage = 12,
    page = 0
)
client.searchUserID(query)

Parameters

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
29
30
{
  "hits": [
    {
      "userID": "user9",
      "clusterName": "c11-test",
      "nbRecords": 3,
      "dataSize": 481,
      "objectID": "user9",
      "_highlightResult": {
        "userID": {
          "value": "<b>user<\/b>9",
          "matchLevel": "full",
          "fullyHighlighted": false,
          "matchedWords": [
            "user"
          ]
        },
        "clusterName": {
          "value": "c11-test",
          "matchLevel": "none",
          "matchedWords": []
        }
      }
    }
  ],
  "nbHits": 10,
  "page": 0,
  "hitsPerPage": 20,
  "updatedAt": 1514902377
}

hits ➔ user object

hits ➔ _highlightResult object

Highlighted attributes. Each attributes contains the following attributes: