Retrieve top filter values

Retrieves the 1,000 most frequent filter (facet) values for a filter attribute.

These are attributes of your records that you included in the attributesForFaceting setting.

GET /2/filters/{attribute}

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/2/filters/brand?index=ALGOLIA_INDEX_NAME&search=enable%20ab%20test&startDate=2022-09-19&endDate=2023-01-21&limit=10&offset=0&tags=device%3Amobile%2520phone' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "values": [
    {
      "attribute": "url",
      "operator": ":",
      "value": "integration",
      "count": 2
    }
  ]
}

Required ACL: analytics

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

attribute · string · required

Attribute name.

Example:

"brand"

Query Parameters

index · string · required

Index name.

Example:

"ALGOLIA_INDEX_NAME"

search · string

Search query.

startDate · string

Start date of the period to analyze, in YYYY-MM-DD format.

Example:

"2022-09-19"

endDate · string

End date of the period to analyze, in YYYY-MM-DD format.

Example:

"2023-01-21"

limit · integer · default: 10

Number of items to return.

Required range: x <= 1000

offset · integer · default: 0

Position of the first item to return.

Required range: x >= 0

tags · string

Tags by which to segment the analytics.

You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.

Response

200

application/json

OK

values · object[] · required

Filter values for an attribute.

Show child attributes

values. attribute · string · required

Attribute name.

Example:

"url"

values. operator · enum<string> · required

Character that characterizes how the filter is applied.

For example, for a facet filter facet:value, : is the operator. For a numeric filter count>50, > is the operator.

Available options: :, <, <=, =, !=, >, >=

Example:

":"

values. value · string · required

Attribute value.

Example:

"integration"

values. count · integer · required

Number of occurrences.

Example:

2