Skip to main content

Filter operators and types reference

Filter operators

Filter operators define how we determine if the contents of a column meet the filter criteria. To get the filter operators that a column supports, use the List columns endpoint.

Name

Include row if filtered column contains:

in

Value that is an exact match for a value in the filter.

contains

Value where any part of the value is an exact match a value in the filter.

For example, if the list of filter values includes the string digicert, any of these column values is a match: digicert, example_digicert, and digicert_example.

month_to_date

Date between the beginning of the current calendar month and now.

quarter_to_date

Date between the beginning of the current quarter and now.

year_to_date

Date between the beginning of the current year and now.

last_30_days

Date within the last 30 days.

last_12_months

Date within the last 12 months.

custom_date

Date within a custom date range.

When using the custom_date operator, the list of values contains two elements that defines a date range. The first element is the start date and the second element is the end date. Use this format for dates: YYYY-MM-DD. For example: ["2021-01-01", "2021-01-31"]

last_month

Date in the previous month.

expires_within_7_days

Expiration date within the next 7 days.

expires_within_30_days

Expiration date within the next 30 days.

expires_within_60_days

Expiration date within the next 60 days.

expires_within_90_days

Expiration date within the next 90 days.

expires_within_120_days

Expiration date within the next 120 days.

expires_within_180_days

Expiration date within the next 180 days.

expired_in_the_last_7_days

Expiration date within the previous 7 days.

expired

Expiration date in the past.

Filter types

A column's filter type describes the values the column can be filtered against.

  • Some columns allow filtering against a list of any custom values.

  • Some columns only allow filtering against a limited set of possible values.

  • Some columns provide filter operators that define the range of matching values. When using one of these operators, the filter criteria should not include a list of values to match against.

To get the filter type for each column in a report, use the List columns endpoint.

Name

Description

multi_value

The value of the column is compared to the values you provide when you create the filter.

  • If the List columns endpoint provides a list of possible values for a column:

    The filter criteria for the column is restricted to these values. If you try to add a filter that uses other values as the filter criteria, the API returns an error.

  • If the List columns endpoint does not provide a list of possible values for a column:

    There are no restrictions on the filter criteria for the column. You can filter against any values you choose.

static

The operator defines the filter criteria for this column. When you create a filter, leave the values array blank.

date

For columns with this filter type, most of the operators are a date range that defines the filter criteria for the column. When you create a filter, leave the values array blank.

The exception is when using the custom_date operator. For this operator, the list of values defines a custom range of dates. The first element is the start date and the second element is the end date. For example, see Add a filter – Examples.

intermediate_ca_api

The value of the column is compared to the list of intermediate ICA names in the filter. To get the names of intermediate ICAs in your account, use the List intermediates endpoint.

user_api

The value of the column is compared to the list of user IDs in the filter. To get the ID value for users in your account, use the List users endpoint.

product_api

The value of the column is compared to the list of product names in the filter. To get the names of products in your account, use the Product list endpoint.

organization_api

The value of the column is compared to the list of organization IDs in the filter. To get the ID value for organizations in your account, use the Organization list endpoint.

dcv_method_api

The value of the column is compared to the list of DCV method identifiers in the filter. To get a list of DCV method identifiers, use the List DCV methods endpoint.

validation_type_api

The value of the column is compared to the list of validation types in the filter. To get a list of validation type identifiers, use the Validation types endpoint.