The SearchJet API is organized into logical categories to help you find the right endpoints quickly. Each category groups related endpoints together, making it easy to manage your search integration from initial setup to advanced analytics.

API Keys

Manage your API keys for authentication. Create new keys, revoke unused ones, and set expiration dates. Each key can be scoped to specific permissions like read-only search or full index management access. Use separate keys for development and production environments.

Client

Client-side endpoints for initializing the SearchJet widget on your website. Configure the search bar appearance, set default filters, and define callback functions for search events. Use these endpoints to embed instant search on any page without a backend integration.

Dashboard

Access your SearchJet dashboard data programmatically. Retrieve project settings, account information, and billing details. Use these endpoints to build custom admin interfaces or automate configuration across multiple sites.

Index

Manage your search index directly via the API. Trigger reindex operations, monitor indexing progress, and configure which content types and fields are indexed. Use these endpoints to keep your search data in sync when content changes on your site.

Profile

Manage your SearchJet profile and account settings. Update contact information, notification preferences, and security settings. These endpoints are useful for building custom account management flows in your application.

Analytics

Retrieve search analytics data to understand user behavior. Get top searches, zero-result queries, search-to-click rates, and conversion metrics. Use these insights to optimize your content strategy and identify product gaps.

Search

Execute search queries programmatically. These endpoints power the instant search experience, returning ranked results in under 200ms. Support for filters, facets, fuzzy matching, and typo tolerance. Use these endpoints to build custom search interfaces or integrate with existing applications.

Search Logs

Access detailed search logs for debugging and optimization. See individual query results, response times, and user interactions. Useful for troubleshooting search relevance issues and monitoring performance.

Sites

Manage multiple sites under one SearchJet account. Add new sites, configure per-site settings, and monitor performance across your entire portfolio. Each site gets its own index and analytics dashboard.

Usage

Track your API usage and quota consumption. Monitor search volume, index size, and bandwidth usage. Set up alerts when you approach plan limits to avoid unexpected charges.

Contact

For API access and support, please contact the developer at support@searchjetengine.com.

Notes

Replace placeholder values like site, key, and id in the endpoints with your actual values before making requests.
Some endpoints may require specific permissions or authentication levels. Check the endpoint documentation for required scopes.
The API follows RESTful principles for most operations. Use standard HTTP methods: GET for reading, POST for creating, PUT for updating, and DELETE for removing resources.
All requests must include your API key in the X-Project-Key header for authentication.
Rate limits apply based on your plan. Free tier allows 10,000 requests per month. Paid plans include higher limits and dedicated support.

Categories