Content Management API > Search result

Search for results

Returns a list of search results matching your query.

By default, it returns 20 results. You can paginate the results using limit and offset parameters. In any case, a maximum number of 100 results is returned.

Query parameters

filterobject

Attributes to filter search results

querystring

Text to search

Example:

"florence apartments"

fuzzyboolean

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

search_index_idstring

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

Example:

"12345"

localestring

Restrict the search on pages in a specific locale

Example:

"it"

build_trigger_idstringDeprecated

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"

pageobject

Parameters to control offset-based pagination

offsetinteger

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

Example:

limitinteger

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
GET https://site-api.datocms.com/search-results?filter[query]=florence%20apartments HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3

1
curl -g 'https://site-api.datocms.com/search-results?filter[query]=florence%20apartments' \
2
   \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3"

1
await fetch(
2
  "https://site-api.datocms.com/search-results?filter[query]=florence%20apartments",
3
  {
4
    headers: {
5
      Authorization: "Bearer YOUR-API-TOKEN",
6
      Accept: "application/json",
7
      "X-Api-Version": "3",
8
    },
9
  },
10
);

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": [
9
    {
10
      "type": "search_result",
11
      "id": "12adNIIB8rFJF1DoTgCk",
12
      "attributes": {
13
        "title": "Florence Apartments for Rent | Long Term Student Accommodation Rentals",
14
        "body_excerpt": "Finding a place to live while planning to study abroad in Florence can be both exciting and challenging. With this in mind, Housing in Florence assists you in finding conveniently-located housing based...",
15
        "url": "http://www.website.com/some-page",
16
        "score": 11.3,
17
        "highlight": {}
18
      }
19
    }
20
  ],
21
  "meta": {
22
    "total_count": 20
23
  }
24
}