Set Extra Header

Required API Key: no ACL required

Method signature

$config = \Algolia\AlgoliaSearch\Config\SearchConfig::create('YourApplicationID', 'YourAdminAPIKey');
$config->setDefaultHeaders([
  headerName => string headerValue
]);
$client = \Algolia\AlgoliaSearch\SearchClient::createWithConfig($config);

config = Algolia::Search::Config.create('YourApplicationID', 'YourAdminAPIKey')
config.set_extra_header(String headerName, String headerValue)
client = Algolia::Search::Client.create_with_config(config)

algoliasearch('YourApplicationID', 'YourAdminAPIKey', {
  headers: {
    headerName: string headerValue
  }
})

config = SearchConfig('YourApplicationID', 'YourAdminAPIKey')
config.headers[headerName] = str headerValue
client = SearchClient.create_with_config(config)

let configuration = SearchConfiguration(applicationID: "YourApplicationID", apiKey: "YourAdminAPIKey")
  .set(\.defaultHeaders, to: [headerName: headerValue]: [HTTPHeaderKey: String]?)

data class ConfigurationSearch(
    val applicationID: ApplicationID,
    val apiKey: APIKey,
    val defaultHeaders: MutableMap<String, String> = mutableMapOf()
) : Configuration

var configuration = new SearchConfig(
  "YourApplicationID",
  "YourAdminAPIKey"
)
{
    DefaultHeaders = new Dictionary<string, string>
    {
      { String headerName, String headerValue }
    }
};
SearchClient client = new SearchClient(configuration);

SearchConfig configuration =
    new SearchConfig.Builder("YourApplicationID", "YourAdminAPIKey")
      .addExtraHeaders(String headerName,  String headerValue)
      .build();

search.NewClientWithConfig(search.Configuration{
  AppID: "YourApplicationID",
  APIKey: "YourAdminAPIKey",
  Headers: map[string]string{
    string headerName: string headerValue,
  },
})

new AlgoliaClient(
  "YourApplicationID",
  "YourAdminAPIKey",
  customHeader = Map(
    headerName -> String headerValue
  )
)

See code examples

About this method # A

Send an extra HTTP header to Algolia for use with later queries.

This method allows you to send the server a specific key-value pair (an extra HTTP header) with every query. By doing this, you are giving the API an additional header that it can be used in situations such as:

Setting X-Forwarded-For for analytics. If your server sends the end user’s IP along with every search, analytics can distinguish between users. Otherwise, analytics uses the server’s IP address, which doesn’t provide user details. Alternatively, see the followingX-Algolia-UserToken example.
Setting X-Algolia-UserToken for analytics. The Analytics API uses the provided value to distinguish between users. It takes priority over any value in X-Forwarded-For. Use this header if you need to forward the end user’s identity without relying on IP addresses.
Setting X-Algolia-UserToken for API key rate limiting.
Setting X-Forwarded-For to ensure that geo-search locations use the user’s IP address, not your back-end server’s. For an example of this, see the aroundLatLngViaIP parameter.

The set extra header method will eventually be replaced by the requestOptions parameter, allowing you to set the header as part of your query parameters.

Examples # A

Copy

1
2
3
4
5
6
$config = \Algolia\AlgoliaSearch\Config\SearchConfig::create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb');
$config->setDefaultHeaders([
  'headerName' => 'headerValue'
]);

$client = \Algolia\AlgoliaSearch\SearchClient::createWithConfig($config);

1
2
config = Algolia::Search::Config.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')
config.headers['NAME-OF-HEADER'] = 'value-of-header'

1
2
3
4
5
const client = algoliasearch('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb', {
  headers: {
    'NAME-OF-HEADER': 'value-of-header'
  }
});

1
2
3
4
config = SearchConfig('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')
config.headers['NAME-OF-HEADER'] = 'value-of-header'

client = SearchClient.create_with_config(config)

1
2
3
4
let configuration = SearchConfiguration(applicationID: "AJ0P3S7DWQ", apiKey: "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
  .set(\.defaultHeaders, to: ["NAME-OF-HEADER": "value-of-header"])

let client = SearchClient(configuration: configuration)

1
2
3
4
5
6
var configuration = new SearchConfig("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
{
    DefaultHeaders = new Dictionary<string, string> { { "NAME-OF-HEADER", "value-of-header" } }
};

SearchClient client = new SearchClient(configuration);

1
2
3
4
5
6
SearchConfig configuration =
new SearchConfig.Builder("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
  .addExtraHeaders("NAME-OF-HEADER", "value-of-header")
  .build();

SearchClient client = DefaultSearchClient.create(configuration);

1
2
3
4
5
6
7
8
9
config := search.Configuration{
  AppID:  "AJ0P3S7DWQ",
  APIKey: "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb",
  Headers: map[string]string{
    "NAME-OF-HEADER": "value-of-header",
  },
}

client := search.NewClientWithConfig(config)

1
2
3
4
5
6
7
val client = new AlgoliaClient(
  "AJ0P3S7DWQ",
  "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb",
  customHeader = Map(
    "NAME-OF-HEADER" -> "value-of-header"
  )
)

1
2
3
4
5
6
val configuration = ConfigurationSearch(
    applicationID = ApplicationID("AJ0P3S7DWQ"),
    apiKey = APIKey("••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb"),
    defaultHeaders = mapOf("NAME-OF-HEADER" to "value-of-header")
)
ClientSearch(configuration)

Parameters # A

`headerName` #	type: string Required Name of the header to add.
`headerValue` #	type: string Required Value of the header to add.

Response # A

No response

Did you find this page helpful?

Set Extra Header

About this method # Found an issue? Edit this page A Edit this page

Examples # Found an issue? Edit this page A Edit this page

Parameters # Found an issue? Edit this page A Edit this page

Response # Found an issue? Edit this page A Edit this page

On this page

About this method # A

Examples # A

Parameters # A

Response # A