• Guides
  • API Reference API
  • Integrations
  • Log in
  • Sign up
  • Dashboard
Algolia Guides

Become an Algolia expert. Get answers about what it can do for you and understand how it works.

Home
Getting started
Sending and managing data
Managing results
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Sending events
Getting analytics
Personalization
A/B Testing
Algolia recommend
Algolia AI
Going to production
Scaling
Security
Solutions
API Clients
PHP
Ruby
JavaScript
Python
Swift
Kotlin
.NET
Java
Go
Scala
UI Components
InstantSearch.js
React InstantSearch
React InstantSearch Hooks
Vue InstantSearch
Angular InstantSearch
InstantSearch iOS
InstantSearch Android
Autocomplete
Recommend
Tools
Crawler Configuration API
API Parameters
Index settings and search parameters
REST API
A full reference of API Endpoints
Algolia Integrations

Discover how to integrate Algolia's technology into popular frameworks and platforms, and the tools we provide to enhance your Algolia experience.

Frameworks
Rails
Symfony
Django
Laravel
Tools
Crawler
CLI
Platforms
Magento 2
WordPress
Shopify
Salesforce Commerce Cloud B2C
Netlify
Zendesk
  • Home
  • API Reference
    • API Methods
    • API Parameters
    • REST API
    • API Clients
      • PHP
      • Ruby
      • JavaScript
      • Python
      • Swift
      • Kotlin
      • .NET
      • Java
      • Go
      • Scala
    • UI Components
      • InstantSearch.js
      • React InstantSearch
      • React InstantSearch Hooks
      • Vue InstantSearch
      • Angular InstantSearch
      • InstantSearch iOS
      • InstantSearch Android
  • Integrations
    • Frameworks
      • Rails
      • Symfony
      • Django
      • Laravel
    • Platforms
      • Magento 2
      • WordPress
      • Shopify
      • Salesforce Commerce Cloud B2C
      • Netlify
      • Zendesk
  • Getting started
    • What is Algolia?
    • How Algolia works
      • In depth
        • Algolia's ecosystem
        • Algolia's features
    • Quick start
      • Tutorials
      • Tracking usage and performance in the dashboard
      • Get started using the dashboard
      • Quickstart with the PHP API client
      • Quickstart with the Ruby API client
      • Quickstart with the JavaScript API client
      • Quickstart with the Python API client
      • Quickstart with the Swift API client
      • Quickstart with the Kotlin API client
      • Quickstart with the .NET API client
      • Quickstart with the Java API client
      • Quickstart with the Go API client
      • Quickstart with the Scala API client
  • Sending and managing data
    • Format and structure your data
      • How to
        • Setting searchable attributes
        • Creating and using nested attributes
        • Reducing record size
        • Handling data relationships
        • Indexing long documents
        • Creating parent-child relationships
      • In depth
        • Preparing your data for indexing
        • What is in a record
        • Data sanitization
        • Data, record size, and usage limits
    • Send and update your data
      • How to
        • Importing from the dashboard
        • Importing with the API
        • Incremental updates
        • Sending records in batches
      • In depth
        • Different synchronization strategies
        • Index operations are asynchronous
        • Handling concurrency with versioning
      • Tutorials
        • Search Parse.com data
        • Search Salesforce data
        • Searching Confluence data
        • Searching Google Drive
        • Search Jira data
    • Manage indices and apps
      • Manage indices
        • How to
          • Export and import indices
          • Move indices
          • Copy indices
          • Delete indices
        • Concepts
          • Choosing between one or more indices
          • Indices and analytics
        • Tutorial
          • Generate a sitemap from an Algolia index
      • Manage your Algolia apps
  • Managing results
    • Relevance overview
      • In depth
        • The eight ranking criteria
        • Defining relevance
        • Finding records
    • Must do
      • Searchable attributes
        • How to
          • Configuring searchable attributes the right way
      • Custom ranking
        • How to
          • Create custom ranking attributes
          • Boosting or penalizing records
          • Controlling precision of custom ranking metrics
          • Enrich your records with Google Analytics data
          • Using the Bayesian average in custom ranking
          • Custom ranking of results per category
    • Refine results
      • Sorting results
        • How to
          • Sort by attribute
          • Sort an index by date
          • Sort an index alphabetically
          • Create a replica index
          • Search in a replica index
          • Delete a replica index
          • Rename a replica index
          • Manage multiple indices
          • UI sorting widgets
        • In depth
          • Exhaustive sorting
          • Relevant sorting
          • Understanding replicas
          • What is the effect of a replica on the number of records?
      • Filtering
        • How to
          • Filter by string
          • Filter by numeric value
          • Filter by boolean
          • Filter by date
          • Filter an array
          • Filter by null or missing attributes
          • Filter by tags
        • In depth
          • Filters and boolean operators
          • Filter scoring
          • Filters and facet filters
      • Faceting
        • How to
          • How to declare attributes for faceting
      • Grouping results
        • How to
          • How to group results
          • Item variations
      • Geo location
        • How to
          • Filter results around a location
          • Filter results inside a rectangle
          • Filter results inside a polygon
          • Geo ranking info
          • How to solve the 180th meridian issue
        • In depth
          • Geo ranking precision
    • Rules
      • Rules overview
        • How to
          • Using conditionless Rules
          • Adding default search parameters with Rules
          • Using Rules to customize search results by platform
        • In depth
          • Implementing Rules
          • Rule matching algorithm
          • Debugging Rules
      • Detecting intent
        • How to
          • Adding filters based on the query
          • Dynamic filtering with Rules
          • Adding search parameters dynamically
          • Detecting keywords
          • Replacing an entire query
      • Merchandising
        • How to
          • Promoting hits
          • Hiding results with Rules
          • Using optional filters
          • Adding banners
          • Merchandising on empty queries
          • Combining multiple consequences
          • Merchandise category pages
          • Merchandising Facets
          • Adding search parameters with JSON templates
        • In depth
          • Optional filters
    • Optimize search results
      • Adding synonyms
        • How to
          • Managing synonyms from the dashboard
        • In depth
          • Regular synonyms
          • One-way synonyms
          • Alternative correction synonyms
          • Synonym placeholders
      • Typo tolerance
        • How to
          • Preventing typosquatting
          • Searching in hyphenated attributes
        • In depth
          • Configuring typo tolerance
      • Handling natural languages
        • How to
          • Multilingual search
          • Set an index's query language
          • Customize stop words
          • Customize plurals and other declensions
          • Customize word segmentation
        • In depth
          • Language-specific configurations
          • Normalization
          • Tokenization
          • Splitting and concatenation
          • Algolia's supported languages
      • Empty or insufficient results
        • In depth
          • Removing words to improve results
      • Improve results with analytics
      • Override engine defaults
        • How to
          • Querying in the middle of a word
        • In depth
          • Prefix searching
          • Adjusting the exact criterion
    • Troubleshooting
      • Troubleshooting search
      • Troubleshooting relevance
  • Building Search UI
    • What is InstantSearch Android?
    • What is Angular InstantSearch?
    • What is InstantSearch iOS?
    • What is InstantSearch.js?
    • What is React InstantSearch Hooks?
    • What is React InstantSearch?
    • What is Vue InstantSearch?
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Installation
    • Installation
    • Installation
    • Installation
    • Installation
    • Installation
    • Installation
    • Upgrade guide for InstantSearch Android
    • Upgrade guides
    • Upgrade guide for InstantSearch iOS
    • Upgrade guides
    • Upgrade guides
    • Upgrade guides
    • Upgrade guides
    • Widgets
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
    • UI & UX patterns
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Pagination
      • Pagination
      • Pagination
      • Pagination
      • Pagination
      • Pagination
      • Pagination
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Geo search
      • Geo search
      • Geo search
      • Geo search
      • Geo search
      • Geo search
      • Geo search
      • Recommend
      • Recommend
      • Recommend
      • OpenSearch protocol
      • OpenSearch protocol
      • OpenSearch protocol
      • OpenSearch protocol
      • OpenSearch protocol
      • Sorting refinements
      • Sorting refinements
      • Filtering patterns
      • Filtering patterns
      • Redirects
      • Redirects
      • Redirects
      • Redirects
      • Redirects
      • Redirects
      • Redirects
      • Structured results
      • Structured results
      • Structured results
      • Structured results
      • Structured results
      • Disabling default browser behavior on search inputs
      • Disabling default browser behavior on search inputs
      • Disabling default browser behavior on search inputs
      • Disabling default browser behavior on search inputs
      • Disabling default browser behavior on search inputs
      • Facet Display
      • Facet Display
      • Facet Display
      • Facet Display
      • Facet Display
      • Facet Display
      • Facet dropdown
      • Voice search
      • Voice search
      • Injecting content between hits
      • Injecting content between hits
      • Injecting content between hits
      • Injecting content between hits
    • Going further
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • API keys/security
      • API keys/security
      • API keys/security
      • API keys/security
      • API keys/security
      • API keys/security
      • API keys/security
      • Routing URLs
      • Routing URLs
      • Routing URLs
      • Routing URLs
      • Routing URLs
      • Send Insights events
      • Send Insights events
      • Send Insights events
      • Send Insights events
      • Send Insights events
      • Send Insights events
      • Send Insights events
      • Integrate Google Analytics
      • Integrate Google Analytics
      • Integrate Google Analytics
      • Integrate Google Analytics
      • Integrate Google Analytics
      • Improve performance
      • Improve performance
      • Improve performance
      • Improve performance
      • Improve performance
      • Improve performance
      • Improve performance
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Back-end search
      • Back-end search
      • Back-end search
      • Back-end search
      • Back-end search
      • Back-end search
      • Back-end search
      • Native
      • Native
      • React Native
      • Native
      • Native
      • Access state outside the lifecycle
      • Server-side rendering
      • Server-side rendering
      • Server-side rendering
      • Server-side rendering
      • Server-side rendering
      • Telemetry
      • Telemetry
    • Ecommerce ui template
      • Overview
      • Overview
      • Overview
      • Getting started
      • Getting started
      • Getting started
      • Components
      • Components
      • Components
      • Customize
    • Resources
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • Unified InstantSearch for Ecommerce
      • Demos
      • Demos
      • Demos
      • Demos
      • Demos
      • Demos
      • Demos
      • SEO-ready search experience checklist
      • SEO-ready search experience checklist
      • SEO-ready search experience checklist
      • SEO-ready search experience checklist
      • SEO-ready search experience checklist
    • Troubleshooting
      • FAQ
      • FAQ
      • FAQ
      • FAQ
      • FAQ
      • FAQ
      • FAQ
  • Sending events
    • Getting started with events
    • Planning which events to send
    • Implementing events
      • Connectors
        • Google Tag Manager
        • Segment
      • Best practices
        • Keeping track of the queryID for conversion events
        • Generating userToken
        • Event properties
      • How to
        • Send events from your back end
        • Send events from your front end
        • Send events from ecommerce platforms
    • Validating events
  • Getting analytics
    • Search analytics
      • Out-of-the-box analytics
        • How to
          • How to remove the empty search from analytics
          • How to set the analytics userToken
      • Click and Conversion Analytics
      • Segmenting your analytics data
        • How to
          • Tag your users by platform
          • Tag your users by age group
          • Tag new and returning users
      • Analytic metrics and reports
        • How to
          • Connect your search with Google Analytics
  • Personalization
    • What is Personalization?
      • In depth
        • How Personalization works
    • Personalizing results
      • In depth
        • Configuring Personalization
    • Going to production
      • How to
        • A/B testing Personalization
        • Enabling Personalization
      • In depth
        • Implementation checklist
  • A/B Testing
    • What is A/B testing
      • How to
        • Prepare your environment for A/B testing
        • Create and run an A/B test
      • In depth
        • Why do A/B testing?
        • How A/B test scores are calculated
    • A/B test implementation checklist
    • How to read your A/B test results
    • Faq
      • FAQ
  • Algolia recommend
    • Overview
    • How to
      • Upload events via CSV
      • Set up Recommend
      • Refine recommendations with Rules
  • Algolia AI
    • Dynamic Synonym Suggestions
    • Dynamic Re-Ranking
      • Tutorials
        • Add Dynamic Re-Ranking to category pages
  • Going to production
    • Preparing your project
    • Implementation checklist
    • Case study for an online clothing company
  • Scaling
    • Servers and clusters
      • How to
        • Capacity alerts
      • In depth
        • Server specs
    • Distributed Search Network (DSN)
    • Multi-Cluster Management (MCM)
      • How to
        • Implementing MCM
    • Scaling to larger datasets
    • Algolia service limits
  • Security
    • API keys
      • How to
        • User-restricted access to data
        • How to restore an API key
      • In depth
        • API key restrictions
    • Security best practices
      • In depth
        • Shared responsibility
    • Algolia Vault
  • Solutions
    • Ecommerce
      • Search
        • Autocomplete
          • Autocomplete with Federated Search
          • Additional patterns: animated placeholders
          • Predictive search suggestions
      • Browse
        • Tutorials
          • Category Pages
        • Product carousels
          • Static product carousels
          • Dynamic product carousels
      • Filtering and Navigation
        • Tutorials
          • Auto-selected facets
          • Filter suggestions
          • Visual facets
          • Guided Search
      • B2B catalog management
        • Tutorials
          • Searching by SKU
          • Personalized catalogs
          • Personalized pricing
      • Business user guide
        • Initial configuration
          • Checklist for going live
          • Permissions
          • Searchable attributes
          • Custom ranking
          • Language settings
          • Faceting
          • Variants
          • Events
          • AI Synonyms
          • AI re-ranking
          • Personalization
          • Replica indices
          • Testing
          • Analytics tags
        • Ongoing optimizations
          • Merchandising playbook
          • Merchandise products on category pages
          • Merchandise facets on category pages
          • Merchandise products on search results pages
      • Visual Image Search
        • Tutorials
          • Image classification and tagging
          • Search by image
      • Build a voice to text search
Algolia.com Developer Hub
API Reference / REST API

REST API

Edit this page A Edit this page

Usage of the REST API without an API client is not directly covered by our SLA.

Search

Monitoring

Usage

Analytics

Insights

A/B testing

Query Suggestions

Recommend

ic-personnalization Created with Sketch.

Personalization

Crawler

© Algolia - Privacy Policy

Support Need help?