API Reference / API Parameters / responseFields

Feb. 26, 2019

responseFields

Type: list of strings

Engine default: * (all fields)

Parameter syntax

'responseFields' => [
  'response_attribute',
  ...
]

responseFields: [
  'response_attribute',
  ...
]

responseFields: [
  'response_attribute',
  ...
]

'responseFields': [
  'response_attribute',
  ...
]

query.responseFields = [
  "response_attribute",
  ...
]

responseFields {
    +ResponseFields
    +...
}

new JSONObject()
  .put(
    "responseFields",
    new JSONArray()
      .put("response_attribute")
      .put("...")
  )

IndexSettings settings = new IndexSettings();
settings.ResponseFields = new List<string>
{
    "response_attribute",
    ...
};

.setResponseFields(
  Arrays.asList(
    "response_attribute",
    ...
  )
)

opt.ResponseFields(
  "response_attribute",
  ...
)

responseFields = Some(Seq(
  "response_attribute",
  ...
))

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, setSettingsAsync, browseAsync, searchForFacetValues Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Choose which fields the response will contain. Applies to search and browse queries.

This parameter is mainly intended to limit the response size. For example, in complex queries, echoing of request parameters in the response’s params field can be undesirable.

Usage notes:

By default, all fields are returned. If this parameter is specified, only the fields explicitly listed will be returned, unless * is used, in which case all fields are returned. Specifying an empty list or unknown field names is an error.
List of fields that can be filtered out:
- aroundLatLng
- automaticRadius
- exhaustiveFacetsCount
- facets
- facets_stats
- hits
- hitsPerPage
- index
- length
- nbHits
- nbPages
- offset
- page
- params
- processingTimeMS
- query
- queryAfterRemoval
- userData
List of fields that cannot be filtered out:
- message
- warning
- cursor
- serverUsed
- indexUsed
- abTestVariantID
- timeoutCounts (deprecated, please use exhaustiveFacetsCount instead)
- timeoutHits (deprecated, please use exhaustiveFacetsCount instead)
- parsedQuery
- all fields triggered by getRankingInfo

Examples

Set default fields to retrieve

Copy

$index->setSettings([
  'responseFields' => [
    'hits',
    'hitsPerPage',
    'nbPages',
    'page'
  ]
]);

index.setSettings(
  new JSONObject()
    .put(
      "responseFields",
      new JSONArray()
        .put("hits")
        .put("hitsPerPage")
        .put("nbPages")
        .put("page")
    )
);

IndexSettings settings = new IndexSettings();
settings.ResponseFields = new List<string>
{
    "hits",
    "hitsPerPage",
    "nbPages",
    "page"
};

index.SetSettings(settings);

index.setSettings(
  new IndexSettings()
    .setResponseFields(
      Arrays.asList(
        "hits",
        "hitsPerPage",
        "nbPages",
        "page"
      )
    )
);

client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    responseFields = Some(Seq(
      "hits",
      "hitsPerPage",
      "nbPages",
      "page"
    ))
  )
}

Override default fields to retrieve for the current search

Copy

$results = $index->search('query', [
  'responseFields' => [
    'hits',
    'facets'
  ]
]);

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

responseFields

About this parameter

Usage notes:

Examples

Set default fields to retrieve

Override default fields to retrieve for the current search

Did you find this page helpful?

On this page