analyticsTags

Type: list of strings
Engine default: []
Parameter syntax
'analyticsTags' => [
  'tag value',
  ...
]
Parameter syntax
analyticsTags: [
  'tag value',
  ...
]
Parameter syntax
analyticsTags: [
  'tag value',
  ...
]
Parameter syntax
'analyticsTags': [
  'tag value',
  ...
]
Parameter syntax
query.analyticsTags = [
  "tag value",
  ...
]
Parameter syntax
.setAnalyticsTags(
  "tag value",
  ...
)
Parameter syntax
.SetAnalyticsTags(
  new string[] {
    "tag value",
    ...
  }
)
Parameter syntax
.setAnalyticsTags(
  Arrays.asList(
    "tag value",
    ...
  )
)
Parameter syntax
"analyticsTags": []string{
  "tag value",
  ...
}
Parameter syntax
analyticsTags = Some(Seq(
  "tag value",
  ...
))

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

About this parameter

List of tags to apply to the query in the analytics.

Tags can be used in the analytics to filter searches. For example, you can send two different tags - mobile and website - to see how mobile users search in comparison to website users.

We have released a new version of our Analytics feature. For now, this feature has been temporarily disabled: we will continue to support the parameter but we will not process it.

Examples

<?php
$results = $index->search('query', [
  'analyticsTags' => [
    'front_end',
    'website2'
  ]
]);
results = index.search('query', {
  analyticsTags: [
    'front_end',
    'website2'
  ]
})
index.search({
  query: 'query',
  analyticsTags: [
    'front_end',
    'website2'
  ]
}).then(res => {
  // console.log(res);
});
results = index.search('query', {
  'analyticsTags': [
    'front_end',
    'website2'
  ]
})
let query = Query(query: "query")
query.analyticsTags = [
  "front_end",
  "website2"
]

index.search(query, completionHandler: { (res, error) in
  print(res)
})
index.search(
  new Query("query")
    .setAnalyticsTags(
      "front_end",
      "website2"
    )
);
index.search(
  new Query("query")
    .SetAnalyticsTags(
      new string[] { "front_end", "website2" }
    )
);
index.search(
  new Query("query")
    .setAnalyticsTags(
      Arrays.asList(
        "front_end",
        "website2"
      )
    )
);
res, err := index.Search("query", algoliasearch.Map{
  "analyticsTags": []string{
    "front_end",
    "website2",
  },
})
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    analyticsTags = Some(Seq(
      "front_end",
      "website2"
    ))
  )
}
Php small white
PHP
Ruby small white
Ruby
Javascript small white
JavaScript
Python small white
Python
Swift small white
iOS
Android small white
Android
Csharp small white
C#
Java small white
Java
Go small white
Go
Scala small white
Scala
Php small white
PHP
Ruby small white
Ruby
Javascript small white
JavaScript
Python small white
Python
Swift small white
iOS
Android small white
Android
Csharp small white
C#
Java small white
Java
Go small white
Go
Scala small white
Scala