analyticsTags
[]
'analyticsTags' => [ '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,
GenerateSecuredApiKeys,
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
About this parameter
List of tags to apply to the query for analytics purposes.
Use analytics tags to group searches into different segments.
For example, you can send two different tags, mobile
and website
, to
compare mobile and website search usage.
Limitations
- 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 up to 10 unique tags. Extra tags are ignored.
- A maximum of 1,750 unique tag combinations every 5 minutes. All extra tags are ignored.
A tags combination is the list of tags in a query.
For example, sending three queries, each tagged with
ios
,en
, andios,en
, counts as three combinations.
Examples
Specify analytics tags for the current search
1
2
3
4
5
6
$results = $index->search('query', [
'analyticsTags' => [
'front_end',
'website2'
]
]);