search
For details where this event is used, see Event types.
Examples
For more information about initializing the JavaScript Insights clientaa
,
see Initialize the Insights client.
Parameters
Name of the specific event.Format: 1-64 ASCII characters, except control characters.To maximize the impact of your events,
use consistent event names and consistent formatting,
for example, “Product Added To Cart” (always in title case).For example, you can adopt Twilio Segment’s object-action framework.
List of facet filters.You can include up to 10 filters.Format:
${attribute}:${value}
—for example, brand:apple
.
Both the attribute
and value
in each facet filter must be URL-encoded individually and separated by a :
, such as, "discount:10%25"
.Name of the Algolia index.Format: same as the index name used by the search engine.Some API clients use
index
instead of indexName
.Anonymous user identifier.See also: User token
Pseudonymous identifier for authenticated users.See also: User token
Don’t include personally identifiable information in user tokens.