analyticsTags

Type: list of strings

Engine default: []

Parameter syntax

'analyticsTags' => [
  'tag value',
  ...
]

analyticsTags: [
  'tag value',
  ...
]

analyticsTags: [
  'tag value',
  ...
]

'analyticsTags': [
  'tag value',
  ...
]

analyticsTags = [
  "tag value",
  ...
]

analyticsTags {
    +"tag value"
    +...
}

.AnalyticsTags(
  new List<string> {
    "tag value",
    ...
  }
)

.setAnalyticsTags(
  Arrays.asList(
    "tag value",
    ...
  )
)

opt.AnalyticsTags(
  "tag value",
  ...
)

analyticsTags = Some(Seq(
  "tag value",
  ...
))

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

List of tags to apply to the query for analytics purposes.

You can use tags in 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.

There are a couple of limitations to keep in mind when sending analytics tags:

Tags can be up to 100 characters long. Longer tags are ignored.
Tags starting with alg# are reserved for internal usage and are ignored.
A query can have a maximum of 10 unique tags. Extra tags are ignored.
A maximum of 1750 unique tag combinations every 5 minutes. All extra tags are ignored. A tags combination is the list of tags found in a query. For example, sending three queries, each respectively tagged with ios, en, and ios,en, counts as 3 combinations.

Guide Segmenting Your Analytics Data

Examples

Specify analytics tags for the current search

Copy

1
2
3
4
5
6
$results = $index->search('query', [
  'analyticsTags' => [
    'front_end',
    'website2'
  ]
]);

1
2
3
4
5
6
7
8
let query = Query("query")
    .set(\.analyticsTags, to: ["front_end", "website2"])
  
index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    analyticsTags = Some(Seq(
      "front_end",
      "website2"
    ))
  )
}

Did you find this page helpful?

analyticsTags

About this parameter

Examples

Specify analytics tags for the current search

On this page