🎉 Try the public beta of the new docs site at algolia.com/doc-beta! 🎉
API Reference / API Parameters / analyticsTags
Type: list of strings
Engine default: []
Parameter syntax
'analyticsTags' => [
  'tag value',
  ...
]

Can be used in these methods:

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 1750 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, and ios,en, counts as three combinations.

Examples

1
2
3
4
5
6
$results = $index->search('query', [
  'analyticsTags' => [
    'front_end',
    'website2'
  ]
]);
Did you find this page helpful?