Content Management API > Search result

Search for results

Query parameters

filter object

Attributes to filter search results

query string

Text to search

Example:

"florence apartments"

fuzzy boolean

When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.

search_index_id string

The search index ID on which the search will be performed. If not provided, the first enabled search index will be used.

Example:

"12345"

locale string

Restrict the search on pages in a specific locale

Example:

"it"

build_trigger_id string Deprecated

The build trigger ID or name on which the search will be performed.

Use search_index_id instead: this parameter is only supported for backward compatibility and will return an error if the build trigger has multiple search indexes associated.

Example:

"44"

page object

Parameters to control offset-based pagination

offset integer

The (zero-based) offset of the first entity returned in the collection (defaults to 0)

Example:

limit integer

The maximum number of entities to return (defaults to 20, maximum is 100)

Returns

Returns an array of resource objects of type search_result

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  // iterates over every page of results
7
  for await (const searchResult of client.searchResults.listPagedIterator({
8
    filter: { query: "florence apartments" },
9
  })) {
10
    // Check the 'Returned output' tab for the result ☝️
11
    console.log(searchResult);
12
  }
13
}
14

15
run();