GET /2/filters/{attribute}

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.

Servers

Path parameters

Name Type Required Description
attribute String Yes

Attribute name.

Query parameters

Name Type Required Description
endDate String No

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

limit Integer No

Number of items to return.

Default value: 10

search String No

Search query.

tags String No

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.

startDate String No

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

index String Yes

Index name.

offset Integer No

Position of the first item to return.

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.