list_filterable_fields

Enumerates every field accepted by the filters parameter on query_ad_metrics, list_events, and list_contacts. For each field, returns the type and the operators that type allows.

When to use

Before authoring a filters object when you’re not certain of the slug or which operator is valid for the type.
Avoids the [validation_error] round-trip from ReportDataValidator.

Parameters

Parameter	Type	Required	Description
`format`	string	No	`csv` (default), `json`, or `yaml`.
`include_unused`	boolean	No	Include `profile_field_*` slots without a configured label (default `false`).
`category`	string	No	Narrow to one category: `contact`, `company`, `ad`, `conversion`, `profile_field`, `all`. Default `all`.

Output

slug,type,operators,label
email,string,equal_to|not_equal_to|starts_with|ends_with|contains|not_contains|contains_word|any|unknown,
country,string,equal_to|not_equal_to|starts_with|ends_with|contains|not_contains|contains_word|any|unknown,
purchase,numeric,equal_to|not_equal_to|greater_than|greater_than_or_equal_to|less_than|less_than_or_equal_to|any|unknown,
profile_field_1,string,equal_to|not_equal_to|...,Customer Plan
profile_field_18,numeric,equal_to|not_equal_to|greater_than|...,Customer Age
profile_field_27,date,equal_to|between|greater_than|...,Signup Date

Tip

Custom profile fields (profile_field_*) are typed by slot range:

profile_field_1 – profile_field_15 → text
profile_field_16 – profile_field_25 → number
profile_field_26 – profile_field_30 → date

The default scope hides profile-field slots without a configured label so the agent isn’t tempted to filter on slots that hold no data.

Get Started

Connecting Clients

Tools

Resources

Prompts

When to use

Parameters

Output

Tip

​When to use

​Parameters

​Output

​Tip

When to use

Parameters

Output

Tip