Search userID

Required API Key: Admin

Method signature

$client->searchUserIds(string query)

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

client.search_user_ids(String query)

client.search_user_ids(String query, Hash opts = {
  clusterName: String,
  query: String,
  page: Integer,
  hitsPerPage: Integer
})

client.searchUserIDs(string query)

client.searchUserIDs(string query, {
  // All the following parameters are optional
  clusterName: string,
  page: integer,
  hitsPerPage: integer,
});

client.search_user_ids(str query)

client.search_user_ids(str query, {
    // All the following parameters are optional
    'clusterName': str clusterName,
    'page': int page,
    'hitsPerPage': int hitsPerPage,
})

client.searchUser(
  with query: UserIDQuery,
  requestOptions: RequestOptions? = nil,
  completion: Result<UserIDSearchResponse> -> Void
)

struct UserIDQuery {
  var query: String?
  var clusterName: ClusterName?
  var page: Int?
  var hitsPerPage: Int?
}

suspend fun ClientSearch.searchUserID(
    query: UserIDQuery = UserIDQuery(),
    requestOptions: RequestOptions? = null
): ResponseSearchUserID

data class UserIDQuery(
    var query: String? = null,
    var clusterName: ClusterName? = null,
    var page: Int? = null,
    var hitsPerPage: Int? = null
)

client.SearchUserIds( new SearchUserIdsRequest {
  Query = String,

  // All the following parameters are optional
  ClusterName = String,
  Page = int,
  HitsPerPage = int
})

client.SsarchUserIds(new SearchUserIdsRequest()
        .setQuery(String query)
        .setCluster(String clusterName)
        .setPage(int page)
        .setHitsPerPage(int hitsPerPage)
)

client.SearchUserIDs(
  query,
  opt.Cluster("clusterName": string),
  opt.Page("page": int),
  opt.HitsPerPage("hitsPerPage": int),
)

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

See code examples

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

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 quickly, 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

Read the Algolia CLI documentation for more information.

Search userID

Copy

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
4
5
6
7
8
9
10
11
let query = UserIDQuery()
  .set(\.query, to: "query")
  .set(\.clusterName, to: "c1-test")
  .set(\.hitsPerPage, to: 12)
  .set(\.page, to: 0)

client.searchUser(with: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

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);

Parameters

Parameter	Description
`query`	type: string Required Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
`clusterName`	type: string default: null Optional If specified only clusters assigned to this cluster can be returned.
`page`	type: integer default: 0 Optional Page to fetch.
`hitsPerPage`	type: integer default: 20 Optional Number of users to return by page.

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

Copy

          {
  "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
}

        

Field	Description
`hits`	list of user object List of user object matching the query.
`nbHits`	integer Number of userIDs matching the query.
`page`	integer Current page.
`hitsPerPage`	integer Number of hits retrieved per page.
`updatedAt`	string Timestamp of the last update of the index

hits ➔ user object

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
`objectID`	string userID of the requested user. Same as userID.
`_highlightResult`	list of _highlightResult object

hits ➔ _highlightResult object

Highlighted attributes. Each attributes contains the following attributes:

Field	Description
`value`	string Markup text with occurrences highlighted. The tags used for highlighting are specified via `highlightPreTag` and `highlightPostTag`.
`matchLevel`	string Indicates how well the attribute matched the search query. Can be: `none` or `partial` or `full`. See search matchLevel for more details.
`matchedWords`	list List of words from the query that matched the object.
`fullyHighlighted`	boolean Whether the entire attribute value is highlighted.

Did you find this page helpful?

Search userID

About this method

Examples

Search userID

Parameters

Response

JSON format

hits ➔ user object

hits ➔ _highlightResult object

On this page