Data & Query Engine

Full-Text Search Engine

Instantly search across any collection or resource with the global ?q= parameter. Matches case-insensitively across top-level string and numeric fields, as well as deeply nested JSON objects.

Live Search Workbench

Pick a preset search or test custom queries across any resource:

Target Resource

Search Term (?q=)

Searches across both "title" and "body" text fields in blog posts.GET /posts?q=optio

Live API RunnerMethod: GET

Live Request Console

GET

response.json

{

// Click "Send" above to execute this request against the live server.

}

Search Traversal & Matching Mechanics

How the Playground search engine evaluates queries across records in your session overlay:

Case-Insensitive Substrings

Searching for ?q=laptop matches "Laptops", "Gaming Laptop", and "LAPTOP" identically.

Recursive Object Traversal

The query engine inspects top-level properties and recursively crawls nested child objects (such as address.city or company.bs).

Session Overlay Awareness

Newly created records, local edits, and custom collections in your active visitor session are instantly searchable alongside global baseline data.

Frontend Integration Recipes

Production patterns featuring debouncing, AbortController, and query cancellation:

hooks/useDebouncedSearch.ts

// hooks/useDebouncedSearch.ts

import { useState, useEffect } from 'react';

export function useDebouncedSearch<T>(resource: string, query: string, delay = 300) {

const [data, setData] = useState<T[]>([]);

const [loading, setLoading] = useState(false);

const [error, setError] = useState<string | null>(null);

useEffect(() => {

if (!query.trim()) {

setData([]);

setLoading(false);

return;

}

setLoading(true);

setError(null);

// AbortController cancels obsolete inflight requests on fast typing

const controller = new AbortController();

const handler = setTimeout(async () => {

try {

const res = await fetch(

https://playground.nileslabs.com/api/v1/${resource}?q=${encodeURIComponent(query.trim())}`,

{

signal: controller.signal,

credentials: 'include'

}

);

if (!res.ok) throw new Error('Search query returned non-200 status');

const json = await res.json();

setData(json.data || json);

} catch (err: any) {

if (err.name !== 'AbortError') {

setError(err.message || 'Search failed');

}

} finally {

setLoading(false);

}

}, delay);

return () => {

clearTimeout(handler);

controller.abort();

};

}, [resource, query, delay]);

return { data, loading, error };

}

Next Query Feature

Dynamic Multi-Type Sorting

Related Query Feature

Offset-Based Pagination

PreviousRelational Filtering

NextDynamic Sorting