> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Search for user IDs
> Since it can take a few seconds to get the data from the different clusters, the response isn't real-time.
To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
**Requires Admin API key**
## OpenAPI
````yaml specs/search.yml post /1/clusters/mapping/search
openapi: 3.1.0
info:
title: Search API
summary: >-
The Algolia Search API lets you search, configure, and manage your indices
and records
description: >
## Client libraries
Use Algolia's API clients and libraries to reliably integrate Algolia's APIs
with your apps.
The official API clients are covered by Algolia's [Service Level
Agreement](https://www.algolia.com/policies/sla).
For more information, see [Algolia's
ecosystem](https://www.algolia.com/doc/libraries).
## Base URLs
Base URLs for the Search API:
- `https://{APPLICATION_ID}.algolia.net`
- `https://{APPLICATION_ID}-dsn.algolia.net`.
If your subscription includes a [Distributed Search Network](https://dashboard.algolia.com/infra),
this ensures that requests are sent to servers closest to users.
Both URLs provide high availability by distributing requests with load
balancing.
**All requests must use HTTPS.**
## Retry strategy
To guarantee high availability, implement a retry strategy for all API
requests using the URLs of your servers as fallbacks:
- `https://{APPLICATION_ID}-1.algolianet.com`
- `https://{APPLICATION_ID}-2.algolianet.com`
- `https://{APPLICATION_ID}-3.algolianet.com`
These URLs use a different DNS provider than the primary URLs.
Randomize this list to ensure an even load across the three servers.
All Algolia API clients implement this retry strategy.
## Authentication
Add these headers to authenticate requests:
- `x-algolia-application-id`. Your Algolia application ID.
- `x-algolia-api-key`. An API key with the necessary permissions to make the
request.
The required access control list (ACL) to make a request is listed in each endpoint's reference.
You can find your application ID and API key in the [Algolia
dashboard](https://dashboard.algolia.com/account/api-keys).
## Request format
Depending on the endpoint, request bodies are either JSON objects or arrays
of JSON objects.
## Parameters
Parameters are passed as query parameters for GET and DELETE requests,
and in the request body for POST and PUT requests.
Query parameters must be
[URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding).
Non-ASCII characters must be UTF-8 encoded.
Plus characters (`+`) are interpreted as spaces.
Arrays as query parameters must be one of:
- A comma-separated string: `attributesToRetrieve=title,description`
- A URL-encoded JSON array:
`attributesToRetrieve=%5B%22title%22,%22description%22%D`
## Response status and errors
The Search API returns JSON responses.
Since JSON doesn't guarantee any specific ordering, don't rely on the order
of attributes in the API response.
Successful responses return `2xx` statuses. Client errors return `4xx`
statuses. Server errors return `5xx` statuses.
Error responses have a `message` property with more information.
## Version
The current version of the Search API is version 1, indicated by the `/1/`
in each endpoint's URL.
version: 1.0.0
servers:
- url: https://{appId}.algolia.net
variables:
appId:
default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-1.algolianet.com
variables:
appId:
default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-2.algolianet.com
variables:
appId:
default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-3.algolianet.com
variables:
appId:
default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-dsn.algolia.net
variables:
appId:
default: ALGOLIA_APPLICATION_ID
security:
- appId: []
apiKey: []
tags:
- name: Advanced
description: Query your logs.
- name: Api Keys
x-displayName: API keys
description: >
Manage your API keys.
API requests must be authenticated with an API key.
API keys can have permissions (access control lists, ACL) and
restrictions.
externalDocs:
url: https://www.algolia.com/doc/guides/security/api-keys
description: API keys.
- name: Clusters
description: |
Multi-cluster operations.
Multi-cluster operations are **deprecated**.
If you have issues with your Algolia infrastructure
due to large volumes of data, contact the Algolia support team.
- name: Dictionaries
description: >
Manage your dictionaries.
Customize language-specific settings, such as stop words, plurals, or word
segmentation.
Dictionaries are application-wide.
externalDocs:
url: >-
https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp
description: Natural languages.
- name: Indices
description: >
Manage your indices and index settings.
Indices are copies of your data that are stored on Algolia's servers.
They're optimal data structures for fast search and are made up of records
and settings.
externalDocs:
url: >-
https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices
description: Manage your indices.
- name: Records
description: >
Add, update, and delete records from your indices.
Records are individual items in your index.
When they match a search query, they're returned as search results, in the
order determined by your ranking.
Records are schemaless JSON objects.
When adding or updating many records, check the [indexing rate
limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
externalDocs:
url: >-
https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data
description: Prepare your records.
- name: Rules
description: >
Create, update, delete, and search for rules.
Rules are _if-then_ statements that you can use to curate search results.
Rules have _conditions_ that can trigger _consequences_.
Consequences are changes to the search results, such as changing the order
of search results or boosting a facet.
This can be useful for tuning specific queries or for merchandising.
externalDocs:
url: https://www.algolia.com/doc/guides/managing-results/rules/rules-overview
description: Index Rules.
- name: Search
description: Search one or more indices for matching records or facet values.
- name: Synonyms
description: |
Create, update, delete, and search for synonyms.
Synonyms are terms that the search engine should consider equal.
externalDocs:
url: >-
https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms
description: Synonyms.
- name: Vaults
description: >-
Algolia Vault lets you restrict access to your clusters to specific IP
addresses and provides disk-level encryption at rest.
externalDocs:
url: https://www.algolia.com/doc/guides/security/algolia-vault
description: Algolia Vault.
- name: _model_index_settings
x-displayName: Index settings
description: |
.
paths:
/1/clusters/mapping/search:
post:
tags:
- Clusters
summary: Search for user IDs
description: >
Since it can take a few seconds to get the data from the different
clusters,
the response isn't real-time.
To ensure rapid updates, the user IDs index isn't built at the same time
as the mapping. Instead, it's built every 12 hours, at the same time as
the update of user ID usage. For example, if you add or move a user ID,
the search will show an old value until the next time the mapping is
rebuilt (every 12 hours).
operationId: searchUserIds
requestBody:
required: true
content:
application/json:
schema:
title: searchUserIdsParams
type: object
description: OK
additionalProperties: false
properties:
query:
type: string
clusterName:
$ref: '#/components/schemas/clusterName'
hitsPerPage:
$ref: '#/components/schemas/hitsPerPage'
page:
$ref: '#/components/schemas/page'
required:
- query
responses:
'200':
description: OK
content:
application/json:
schema:
title: searchUserIdsResponse
type: object
description: userIDs data.
properties:
hits:
type: array
description: User objects that match the query.
items:
title: userHit
type: object
properties:
_highlightResult:
title: userHighlightResult
type: object
properties:
clusterName:
$ref: '#/components/schemas/highlightResult'
userID:
$ref: '#/components/schemas/highlightResult'
required:
- userID
- clusterName
clusterName:
$ref: '#/components/schemas/clusterName'
dataSize:
$ref: '#/components/schemas/dataSize'
nbRecords:
$ref: '#/components/schemas/nbRecords'
objectID:
type: string
description: userID of the requested user. Same as userID.
userID:
$ref: '#/components/schemas/userID'
required:
- userID
- clusterName
- nbRecords
- dataSize
- objectID
- _highlightResult
hitsPerPage:
$ref: '#/components/schemas/parameters_hitsPerPage'
nbHits:
$ref: '#/components/schemas/nbHits'
page:
$ref: '#/components/schemas/page'
updatedAt:
$ref: '#/components/schemas/updatedAt'
required:
- hits
- nbHits
- page
- hitsPerPage
- updatedAt
'400':
$ref: '#/components/responses/BadRequest'
'402':
$ref: '#/components/responses/FeatureNotEnabled'
'403':
$ref: '#/components/responses/MethodNotAllowed'
'404':
$ref: '#/components/responses/IndexNotFound'
deprecated: true
x-codeSamples:
- lang: csharp
label: C#
source: >-
// Initialize the client
var client = new SearchClient(new
SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
// Call the API
var response = await client.SearchUserIdsAsync(
new SearchUserIdsParams
{
Query = "test",
ClusterName = "theClusterName",
Page = 5,
HitsPerPage = 10,
}
);
// print the response
Console.WriteLine(response);
- lang: dart
label: Dart
source: |-
// Initialize the client
final client =
SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');
// Call the API
final response = await client.searchUserIds(
searchUserIdsParams: SearchUserIdsParams(
query: "test",
clusterName: "theClusterName",
page: 5,
hitsPerPage: 10,
),
);
// print the response
print(response);
- lang: go
label: Go
source: >-
// Initialize the client
client, err := search.NewClient("ALGOLIA_APPLICATION_ID",
"ALGOLIA_API_KEY")
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err :=
client.SearchUserIds(client.NewApiSearchUserIdsRequest(
search.NewEmptySearchUserIdsParams().SetQuery("test").SetClusterName("theClusterName").SetPage(5).SetHitsPerPage(10)))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)
- lang: java
label: Java
source: >-
// Initialize the client
SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID",
"ALGOLIA_API_KEY");
// Call the API
SearchUserIdsResponse response = client.searchUserIds(
new SearchUserIdsParams().setQuery("test").setClusterName("theClusterName").setPage(5).setHitsPerPage(10)
);
// print the response
System.out.println(response);
- lang: javascript
label: JavaScript
source: >-
// Initialize the client
const client = algoliasearch('ALGOLIA_APPLICATION_ID',
'ALGOLIA_API_KEY');
// Call the API
const response = await client.searchUserIds({
query: 'test',
clusterName: 'theClusterName',
page: 5,
hitsPerPage: 10,
});
// print the response
console.log(response);
- lang: kotlin
label: Kotlin
source: >-
// Initialize the client
val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey =
"ALGOLIA_API_KEY")
// Call the API
var response =
client.searchUserIds(
searchUserIdsParams =
SearchUserIdsParams(
query = "test",
clusterName = "theClusterName",
page = 5,
hitsPerPage = 10,
)
)
// print the response
println(response)
- lang: php
label: PHP
source: >-
// Initialize the client
$client = SearchClient::create('ALGOLIA_APPLICATION_ID',
'ALGOLIA_API_KEY');
// Call the API
$response = $client->searchUserIds(
['query' => 'test',
'clusterName' => 'theClusterName',
'page' => 5,
'hitsPerPage' => 10,
],
);
// print the response
var_dump($response);
- lang: python
label: Python
source: >-
# Initialize the client
# In an asynchronous context, you can use SearchClient instead,
which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID",
"ALGOLIA_API_KEY")
# Call the API
response = client.search_user_ids(
search_user_ids_params={
"query": "test",
"clusterName": "theClusterName",
"page": 5,
"hitsPerPage": 10,
},
)
# print the response
print(response)
- lang: ruby
label: Ruby
source: >-
# Initialize the client
client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID",
"ALGOLIA_API_KEY")
# Call the API
response = client.search_user_ids(
Algolia::Search::SearchUserIdsParams.new(query: "test", cluster_name: "theClusterName", page: 5, hits_per_page: 10)
)
# print the response
puts(response)
- lang: scala
label: Scala
source: >-
// Initialize the client
val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey =
"ALGOLIA_API_KEY")
// Call the API
val response = Await.result(
client.searchUserIds(
searchUserIdsParams = SearchUserIdsParams(
query = "test",
clusterName = Some("theClusterName"),
page = Some(5),
hitsPerPage = Some(10)
)
),
Duration(100, "sec")
)
// print the response
println(response)
- lang: swift
label: Swift
source: >-
// Initialize the client
let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID",
apiKey: "ALGOLIA_API_KEY")
// Call the API
let response = try await client.searchUserIds(searchUserIdsParams:
SearchUserIdsParams(
query: "test",
clusterName: "theClusterName",
page: 5,
hitsPerPage: 10
))
// print the response
print(response)
- lang: cURL
label: curl
source: |-
curl --request POST \
--url https://algolia_application_id.algolia.net/1/clusters/mapping/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
--data '
{
"query": "lorem",
"clusterName": "c11-test",
"page": 0,
"hitsPerPage": 20
}
'
components:
schemas:
clusterName:
type: string
description: Cluster name.
example: c11-test
hitsPerPage:
type: integer
description: Number of hits per page.
default: 20
minimum: 1
maximum: 1000
x-categories:
- Pagination
page:
type: integer
description: Page of search results to retrieve.
default: 0
minimum: 0
x-categories:
- Pagination
highlightResult:
oneOf:
- $ref: '#/components/schemas/highlightResultOption'
- $ref: '#/components/schemas/highlightResultMap'
- $ref: '#/components/schemas/highlightResultArray'
dataSize:
type: integer
description: Data size taken by all the users assigned to the cluster.
example: 481
nbRecords:
type: integer
description: Number of records in the cluster.
example: 3
userID:
type: string
pattern: ^[a-zA-Z0-9 \-*.]+$
description: Unique identifier of the user who makes the search request.
example: user1
parameters_hitsPerPage:
type: integer
default: 20
minimum: 1
maximum: 1000
description: >
Maximum number of hits per page.
Algolia uses `page` and `hitsPerPage` to control how search results are
displayed
([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).
- `hitsPerPage`: sets the number of search results (_hits_) displayed
per page.
- `page`: specifies the page number of the search results you want to
retrieve. Page numbering starts at 0, so the first page is `page=0`, the
second is `page=1`, and so on.
For example, to display 10 results per page starting from the third
page, set `hitsPerPage` to 10 and `page` to 2.
nbHits:
type: integer
description: Number of results (hits).
example: 20
updatedAt:
type: string
example: '2023-07-04T12:49:15Z'
description: Date and time when the object was updated, in RFC 3339 format.
highlightResultOption:
title: highlightResultOption
type: object
description: Surround words that match the query with HTML tags for highlighting.
additionalProperties: false
properties:
matchedWords:
type: array
description: List of matched words from the search query.
example:
- action
items:
type: string
matchLevel:
$ref: '#/components/schemas/matchLevel'
value:
$ref: '#/components/schemas/highlightedValue'
fullyHighlighted:
type: boolean
description: Whether the entire attribute value is highlighted.
required:
- value
- matchLevel
- matchedWords
x-discriminator-fields:
- matchLevel
- matchedWords
highlightResultMap:
title: highlightResultMap
type: object
description: Surround words that match the query with HTML tags for highlighting.
x-is-free-form: false
additionalProperties:
$ref: '#/components/schemas/highlightResult'
x-additionalPropertiesName: attribute
highlightResultArray:
title: highlightResultArray
type: array
description: Surround words that match the query with HTML tags for highlighting.
items:
$ref: '#/components/schemas/highlightResult'
ErrorBase:
description: Error.
type: object
x-keep-model: true
additionalProperties: true
properties:
message:
type: string
example: Invalid Application-Id or API-Key
matchLevel:
type: string
description: Whether the whole query string matches or only a part.
enum:
- none
- partial
- full
highlightedValue:
type: string
description: Highlighted attribute value, including HTML tags.
example: George Clooney
responses:
BadRequest:
description: Bad request or request arguments.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBase'
FeatureNotEnabled:
description: This feature is not enabled on your Algolia account.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBase'
MethodNotAllowed:
description: Method not allowed with this API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBase'
IndexNotFound:
description: Index not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorBase'
securitySchemes:
appId:
type: apiKey
in: header
name: x-algolia-application-id
description: Your Algolia application ID.
apiKey:
type: apiKey
in: header
name: x-algolia-api-key
description: >
Your Algolia API key with the necessary permissions to make the request.
Permissions are controlled through access control lists (ACL) and access
restrictions.
The required ACL to make a request is listed in each endpoint's
reference.
````