analytics

Type: boolean

Engine default: true

Parameter syntax

'analytics' => true|false

analytics: true|false

analytics: true|false

'analytics': True|False

analytics = true|false

analytics: Boolean = true|false

.Analytics(true|false)

.setGetAnalytics(true|false)

opt.Analytics(true|false)

analytics = Some(true|false)

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

See code examples

About this parameter

Whether the current query will be taken into account in the Analytics.

Usage notes

Algolia captures analytics on every search. This is the default setting. Therefore, this setting’s primary use is to turn analytics off for a given query.

Examples

Disable analytics for the current search

Copy

1
2
3
$results = $index->search('query', [
  'analytics' => false
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.analytics, to: false)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Enable analytics for the current search and forward IP

Copy

1
2
3
4
5
6
7
8
9
10
11
/*
'94.228.178.246' should be replaced with your end user IP.
Depending on your stack there are multiple ways to get this information.
*/

$ip = '94.228.178.246';
$client->setExtraHeader('X-Forwarded-For', $ip);

$results = $index->search('query', [
  'analytics' => true
]);

1
2
3
4
5
6
7
8
9
10
11
12
13
client = Algolia::Search::Client.new('YourApplicationID', 'YourSearchOnlyAPIKey')
index = client.init_index('index_name')

# '94.228.178.246' should be replaced with your end user IP.
# Depending on your stack there are multiple ways to get this information.
ip = '94.228.178.246'

results = index.search('query', {
  analytics: true,
  headers: {
    'X-Forwarded-For': ip
  }
})

1
2
3
4
5
6
7
8
9
10
11
12
13
// '94.228.178.246' should be replaced with your end user IP.
// Depending on your stack there are multiple ways to get this information.
const client = algoliasearch('YourApplicationID', 'YourSearchOnlyAPIKey', {
  headers: { 'X-Forwarded-For': '94.228.178.246' }
});

const index = client.initIndex('index_name');

index.search('query', {
  analytics: true
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# '94.228.178.246' should be replaced with your end user IP.
# Depending on your stack there are multiple ways to get this information.
config = SearchConfig(
    'YourApplicationID',
    'YourSearchOnlyAPIKey'
)

ip = '94.228.178.246'

config.headers['X-Forwarded-For'] = ip

client = SearchClient.create_with_config(config)
index = client.init_index('index_name')

results = index.search('query', {
    'analytics': True
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/// '94.228.178.246' should be replaced with the actual IP you would like
/// Depending on your stack there are multiple ways to get this information.
let configuration = SearchConfiguration(
  applicationID: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey"
)
  .set(\.defaultHeaders, to: ["X-Forwarded-For": "94.228.178.246"])
let client = SearchClient(configuration: configuration)
let index = client.index(withName: "index_name")

let query = Query("query")
  .set(\.analytics, to: true)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// "94.228.178.246" should be replaced with your end user IP.
// Depending on your stack there are multiple ways to get this information.
val client = ClientSearch(
    ConfigurationSearch(
        applicationID = ApplicationID("Your Application ID"),
        apiKey = APIKey("Your APP ID"),
        defaultHeaders = mapOf("X-Forwarded-For" to "94.228.178.246")
    )
)
val index = client.initIndex(IndexName("index_name"))

val query = query("query") {
    analytics = true
}

index.search(query)

1
2
3
4
5
6
7
// '94.228.178.246' should be replaced with your end user IP.
// Depending on your stack there are multiple ways to get this information.

index.Search<T>(
  new Query("query"){ Analytics = true },
  new RequestOptions { Headers = new Dictionary<string, string> { { "X-Forwarded-For", "94.228.178.246" } } }
);

1
2
3
4
5
6
7
8
9
// '94.228.178.246' should be replaced with your end user IP.
// Depending on your stack there are multiple ways to get this information.

index.search(
  new Query("query")
    .setAnalytics(true),
  new RequestOptions()
    .addExtraHeader("X-Forwarded-For", "94.228.178.246")
);

1
2
3
4
5
6
7
8
9
10
11
// '94.228.178.246' should be replaced with your end user IP.
// Depending on your stack there are multiple ways to get this information.
extraHeaders := opt.ExtraHeaders(map[string]string{
  "X-Forwarded-For": "94.228.178.246",
})

res, err := index.Search(
  "query",
  opt.Analytics(true),
  extraHeaders,
)

1
2
3
4
5
6
7
8
9
10
11
12
13
// '94.228.178.246' should be replaced with your end user IP.
// Depending on your stack there are multiple ways to get this information.

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    analytics = Some(true)
  ) options RequestsOptions(
    extraHeaders = Some(
      Map("X-Forwarded-For" -> "94.228.178.246")
    )
  )
}

Note: in the above example, the IP was forwarded. This line of code is actually only useful when doing backend search.

The analytics feature relies on enduser IPs of search requests to:

find the location of the queries
compute some metrics like number of searches per IP

Therefore, when doing backend search, you need to forward the IP of the end user. Otherwise Algolia will see the queries coming from only one IP: the IP of your backend server.