Filters
The Filters APIs allow you to retrieve, update, or create filters programmatically through Adobe Developer. The APIs use the same data and methods that are used when working with filters in the UI. See Filters overview in the CJA documentation for more information.
You can call the /filters endpoint to add, edit or delete filters.
Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.
Retrieve a list of filters
In CJA, you can navigate to Components > Filters and see a list of filters that you created or others have shared. This call is helpful to identify the ID's of desired filters.
GET https://cja.adobe.io/filters
See GET List of filters in the API reference for supported query string parameters and example responses.
Retrieve a single filter
Once you have the desired ID, you can append the ID to the call to retrieve details on a single filter:
GET https://cja.adobe.io/filters/{id}
Create a filter
Create a new filter with the desired definition.
POST https://cja.adobe.io/filters
An example POST body:
Copied to your clipboard{"dataId": "{DATAID}","compatibility": null,"definition": {"container": {"func": "container","pred": {"evt": {"func": "event","name": "metrics/visits"},"func": "event-exists","description": "purchase id"},"context": "hits"},"func": "segment","version": [1,0,0]},"name": "Integration Test Seg 1","description": "For Integration Test Only"}
