Package selection guidance compiled from public package information, community data, and project usage.
The algolia_client_insights package is a Dart/Flutter extension for the AlgoliaSearch library, designed to enhance search and discovery experiences by enabling detailed user behavior tracking and analytics. It integrates seamlessly with Algolia's insights platform, allowing developers to capture search events such as clicks, conversions, and queries, which can be used to refine search relevance and personalize user experiences. Built for cross-platform use, it supports Android, iOS, Web, macOS, Windows, and Linux, making it ideal for apps aiming to optimize search performance through data-driven insights.
Use cases
Tracking user search interactions
Analyzing search funnel performance
Improving search relevance with behavioral data
Personalizing search results
Monitoring conversion rates from search
Integrating search analytics into dashboards
Key features
Real-time event tracking
Cross-platform compatibility
Seamless integration with Algolia Insights
Support for click and conversion events
Data-driven search optimization
Lightweight and easy-to-use API
Suitable for
Apps with high search volume
E-commerce platforms
Content discovery applications
Products requiring personalized search
Teams focused on UX improvement
Developers using Algolia Search
Considerations
Requires an Algolia account and API keys
Depends on the main AlgoliaSearch package
Limited to Algolia's analytics ecosystem
Privacy compliance required for user data
Network requests may impact performance if not managed
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
The perfect starting point to integrate Algolia within your Dart project
algoliasearch is a comprehensive Dart package that provides access to Algolia's robust search and insights features. It is an all-in-one solution designed to help you integrate Algolia within your Dart project seamlessly and efficiently.
The package currently offers the following clients:
Search Client: Allows you to leverage Algolia's search capabilities, including instant search results, search-as-you-type, and typo-tolerance.
Insights Client: Enables you to collect events related to your search and discovery experience, providing valuable insights into user behavior. With it, you can unlock powerful features such as recommendations, personalization, and smarter search results.
Search Lite Client: A lighter, search-only version of the library, perfect for projects that require search functionality without the need for features like indexing.
Future updates will include more clients to cover the entirety of Algolia's feature set, providing a complete toolset for building powerful, interactive search experiences in your Dart or Flutter application.
✨ Features
Low-Level HTTP Client: Provides a thin and minimal low-level HTTP client to interact directly with Algolia's API, giving you maximum control over your requests.
Cross-Platform Compatibility: Designed to work seamlessly on both native and web platforms, making it ideal for any Dart project.
Pure Dart Construction: Built with pure Dart for superior performance and maximum compatibility across Dart projects.
💡 Getting Started
Step 1: Add Dependency
To use this package in your project, add it as a dependency:
For Dart projects:
dart pub add algoliasearch
For Flutter projects:
flutter pub add algoliasearch
Step 2: Import the Package
You can now import the Algolia API client in your project and play with it.
import'package:algolia_client_search/algolia_client_search.dart';
// Alternatively, you can import `algoliasearch_lite`, a **search-only** version of the library, if you do not need the full feature set:// import 'package:algoliasearch/algoliasearch_lite.dart';final client = SearchClient(appId: 'YOUR_APP_ID', apiKey: 'YOUR_API_KEY');
// Add a new record to your Algolia indexfinal response = await client.saveObject(
indexName: "<YOUR_INDEX_NAME>",
body: {
'objectID': "id",
'test': "val",
},
);
// Poll the task status to know when it has been indexedawait client.waitTask('<YOUR_INDEX_NAME>', response.taskID);
// Fetch search results, with typo tolerancefinal response = await client.search(
searchMethodParams: SearchMethodParams(
requests: [
SearchForHits(
indexName: "<YOUR_INDEX_NAME>",
query: "<YOUR_QUERY>",
hitsPerPage: 50,
),
],
),
);
❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue
Contributing
This repository hosts the code of the generated Algolia API client for Dart, if you'd like to contribute, head over to the main repository. You can also find contributing guides on our documentation website.
📄 License
The Algolia Dart API Client is an open-sourced software licensed under the MIT license.