Skip to main content
The responseFields parameter controls which fields are included in the search response. By default, Algolia includes all fields. Use this setting to reduce the size of the response.

​
Usage

  • To reduce the size of individual records in the response, use attributesToRetrieve.
  • If responseFields is an empty list, the response may return an empty response, except fields that are always included.
  • If you include unknown field names, the API returns an error.
Before using this parameter, check the impact on your search experience. For example, if you omit the hits field, the response won’t include results. The UI may also depend on other fields, for example, for pagination.

​
Fields you can exclude

  • aroundLatLng
  • automaticRadius
  • exhaustive
  • facets_stats
  • facets
  • hitsPerPage
  • hits
  • index
  • length
  • nbHits
  • nbPages
  • offset
  • page
  • params
  • processingTimeMS
  • queryAfterRemoval
  • query
  • serverTimeMS
  • userData

​
Fields you cannot exclude

  • abTestVariantID
  • cursor
  • message
  • warning
  • Fields added by getRankingInfo

​
Example

Current API clients

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings
  {
    ResponseFields = new List<string> { "hits", "hitsPerPage", "nbPages", "page" },
  }
);

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

index.SetSettings(settings);