Skip to main content

List Campaign Filters

GET 

/campaign-filters

Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    start int32

    Default value: 0

    Start/Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    includeSystemFilters boolean

    Default value: true

    If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.

    Example: true

Responses

List of campaign filter objects.

Schema

    items

    object[]

    List of campaign filters.

  • Array [

  • id stringrequired

    The unique ID of the campaign filter

    name stringrequired

    Campaign filter name.

    description string

    Campaign filter description.

    owner stringnullablerequired

    Owner of the filter. This field automatically populates at creation time with the current user.

    mode required

    Possible values: [INCLUSION, EXCLUSION]

    Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria.

    criteriaList

    object[]

    List of criteria.

  • Array [

  • type CriteriaType (string)required

    Possible values: [COMPOSITE, ROLE, IDENTITY, IDENTITY_ATTRIBUTE, ENTITLEMENT, ACCESS_PROFILE, SOURCE, ACCOUNT, AGGREGATED_ENTITLEMENT, INVALID_CERTIFIABLE_ENTITY]

    Type of the criteria in the filter. The COMPOSITE filter can contain multiple filters in an AND/OR relationship.

    operation Operation (string)nullablerequired

    Possible values: [EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, AND, OR, null]

    Operation on a specific criteria

    property stringnullablerequired

    Specified key from the type of criteria.

    value stringnullablerequired

    Value for the specified key from the type of criteria.

  • ]

  • isSystemFilter booleanrequired

    If true, the filter is created by the system. If false, the filter is created by a user.

  • ]

  • count integer

    Number of filters returned.

Loading...