Filters

The Filters APIs allow you to retrieve, update, or create filters programmatically through Adobe I/O. 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.

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:

{
    "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"
}
CopyCopied to your clipboard
1{
2    "dataId": "{DATAID}",
3    "compatibility": null,
4    "definition": {
5        "container": {
6            "func": "container",
7            "pred": {
8                "evt": {
9                    "func": "event",
10                    "name": "metrics/visits"
11                },
12                "func": "event-exists",
13                "description": "purchase id"
14            },
15            "context": "hits"
16        },
17        "func": "segment",
18        "version": [
19            1,
20            0,
21            0
22        ]
23    },
24    "name": "Integration Test Seg 1",
25    "description": "For Integration Test Only"
26}

Last updated 8/11/2021

Was this helpful?

Yes

No