Actions27
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
Clusters → Search for user IDs
AI-generatedOverview
This node operation allows searching for user IDs within Algolia clusters. It is useful in scenarios where you need to find specific user IDs based on a query string, optionally filtered by cluster name, and supports pagination to manage large result sets. For example, you can search for user IDs matching a certain pattern or keyword within a specified cluster and retrieve results page by page.
Use Case Examples
- Search for user IDs containing 'user123' in cluster 'c11-test', retrieving 20 hits per page on page 1.
- Find user IDs matching 'admin' across all clusters, with default pagination settings.
Properties
| Name | Meaning |
|---|---|
| Query | The search query string used to find matching user IDs. |
| Cluster Name | Optional cluster name to narrow down the search to a specific cluster. |
| Page | Page number of search results to retrieve, used for pagination. |
| Hits Per Page | Number of user ID hits to retrieve per page, controlling the page size. |
Output
JSON
userIDs- List of user IDs matching the search query.page- Current page number of the search results.hitsPerPage- Number of hits returned per page.totalHits- Total number of matching user IDs found.
Dependencies
- Algolia API with appropriate credentials for cluster and user ID management.
Troubleshooting
- Ensure the query string is not empty as it is required for the search operation.
- Verify that the cluster name, if provided, is correct and accessible.
- Check API credentials and permissions to access cluster user ID data.
- Handle pagination parameters correctly to avoid missing or duplicate results.
Links
- Algolia Clusters API - Search for User IDs - Official Algolia API documentation for searching user IDs within clusters.