Add user agent

This method is only available for JavaScript.

Required API Key: any key with the search ACL

Method signature

Only available for JavaScript

Only available for JavaScript

aa('addAlgoliaAgent', string userAgent);

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Add a custom user agent to the request.

You can’t override the default user agent, but you can add a custom string to it.

Read the Algolia CLI documentation for more information.

The following example adds the string custom to the default user agent: insights-js (X.X.X); custom.

For more information about initializing the Insights client aa, see Initialize the Insights client.

Copy
aa('addAlgoliaAgent', 'custom');


            userAgent

type: string

Custom user agent. This gets added to the default user agent.

This method doesn't return a response.

Did you find this page helpful?