🎉 Try the public beta of the new docs site at algolia.com/doc-beta! 🎉
API client / Methods / Insights
Required API Key: any key with the search ACL
Method signature
$insights->user(userToken)->viewedFilters(
  string eventName,
  string indexName,
  array filters
)

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

About this method # A

Send a view event to capture the active filters for items a user viewed.

When users browse a category page, they see content filtered on that specific category.

To capture the active filters, send a viewEvent.

Sending this event is useful for:

Examples # A

1
2
3
4
5
6
7
8
9
10
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'AJ0P3S7DWQ',
  '90dfaaf5755e694f341fe68f6e41a6d4'
);

$insights->user("user-123456")->viewedFilters(
  'Brand Viewed',
  'YourIndexName',
  ['brand:google']
);

Parameters # A

Parameter Description
userToken #
type: string
pattern: [A-Za-z0-9_=+/-]{1,129}
Required

Anonymous user identifier.

See also: User Token

authenticatedUserToken #
type: string
pattern: [A-Za-z0-9_=+/-]{1,129}
Optional

Pseudonymous identifier for authenticated users.

Never include personally identifiable information in user tokens.

See also: User Token

eventName #
type: string
pattern: [\x20-\x7E]{1,64}
Required

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 Segment’s object-action framework.

indexName #
type: string
Required

Name of the Algolia index.

Format: same as the index name used by the search engine.

Some API clients use index instead of indexName.

filters #
type: array
items: string
pattern: ${attr}:${value}
Required

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".

Response # A

This method doesn't return a response.

Did you find this page helpful?
PHP v3