Get Contactfilter Rules and Criteria

Retrieves the configuration of a contactfilter, including its rules and selection criteria, in JSON format.

GET https://api.maileon.com/1.0/contactfilters/v2/contactfilter/:contactFilterId

Attributes

Example

GET https://api.maileon.com/1.0/contactfilters/v2/contactfilter/1
Content-type: application/json
Accept: application/json
Authorization: [XXX]

Status: 200 OK
Content-Type: application/json

{
    "standard": false,
    "name": "Test filter",
    "fixed": false,
    "rules": [
        {
            "rule_id": 70,
            "selection": {
                "selection_base": "response",
                "criterion": {
                    "type": "opens",
                    "operation": "greaterequals",
                    "value": 1
                },
                "optional_conditions": {
                    "limitation": {
                        "type": "relative",
                        "operation": "greaterequals",
                        "value": [
                            180,
                            "day"
                        ]
                    }
                }
            },
            "startset": "active",
            "operation": "intersection"
        }
    ],
    "version": 2
}

Example interpretation

In the example above, the filter contains one rule:

• The contact must have at least 1 open (opens / greaterequals / 1).
• The open must have occurred within the specified relative limitation of 180 days.
• The rule starts from the active contact set.
• The rule uses the intersection operation.

The fields returned by this endpoint are specified in the schema documentation.