Filters reference
Every field you can filter an audience on, with its operators and allowed values.
An audience's filters object has two layers. Use the shorthand groups for the common cases,
and where[] clauses for anything else. Everything you send must match (AND).
GET /v1/filters returns this same list as JSON, so you can build a filter picker from it.
Shorthand filters
| Key | What it does |
|---|---|
type | b2c (Consumers (B2C)), b2b (Businesses (B2B)) or people (People). Required. |
topics | 1 to 5 intent topic ids from GET /v1/topics. Required for b2c and b2b, not allowed for people. |
intent | Intent levels to keep: high (๐ฅ Hot), medium (Warm), low (Cold). Intent audiences only. |
active_within_days | Only people who showed intent in the last 1 to 14 days. Intent audiences only. |
location | states (two-letter codes), zips, cities. |
demographics | gender, age, income, net_worth (lists), homeowner, married, children (true or false). |
job | titles (substring match), seniority, departments. |
company | names, domains, industries, size, revenue. |
where | Up to 25 clauses on any field below. |
Topics count across topics and any topic clauses in where: at most 5 distinct ids in total.
where[] clauses
{
"type": "b2c",
"topics": ["tp_4521"],
"where": [
{ "field": "state", "op": "in", "value": ["TX", "OK"] },
{ "field": "job_title", "op": "contains", "value": "engineer" },
{ "field": "income", "op": "in", "value": ["100-150k", "150-250k"] },
{ "field": "mobile_phone", "op": "has_value" }
]
}value is a list for in and not_in, a single string for the other operators, and left out
for has_value and has_no_value. Dates are YYYY-MM-DD. active_date must fall in the last
14 days (UTC). A field, operator or value the catalog doesn't allow fails with
invalid_filters and a details entry such as where.0.op.
Operators
| Operator | Meaning |
|---|---|
eq | Equals one value. |
neq | Does not equal one value. |
lt | Before a date. |
gt | After a date. |
lte | On or before a date. |
gte | On or after a date. |
between | Between value and value_to, inclusive. |
in | Matches any value in a list. |
not_in | Matches none of the values in a list. |
contains | Contains the text, case-insensitive. |
has_value | The field is filled in. No value. |
has_no_value | The field is empty. No value. |
Intent
| Field | Label | Operators | Values | Audience types |
|---|---|---|---|---|
active_date | Active date | eq lt gt lte gte between | YYYY-MM-DD | Consumers (B2C), Businesses (B2B) |
topic | Topic | in not_in | Topic ids (tp_123) | Consumers (B2C), Businesses (B2B) |
intent_level | Intent level | in not_in | high medium low | Consumers (B2C), Businesses (B2B) |
topic_category | Topic category | eq neq in not_in | Free text | Consumers (B2C) |
topic_subcategory | Topic subcategory | eq neq in not_in | Free text | Consumers (B2C) |
Location
| Field | Label | Operators | Values | Audience types |
|---|---|---|---|---|
address_line1 | Address | eq neq in not_in contains has_value | Free text | All |
address_line2 | Address line 2 | eq neq in not_in contains has_value | Free text | All |
city | City | eq neq in not_in contains has_value | Free text | All |
state | State | in not_in | AK AL AR AZ CA CO CT DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY OH OK OR PA RI SC SD TN TX UT VA VT WA WI WV WY | All |
zip | ZIP code | eq neq in not_in | Free text | All |
zip4 | ZIP+4 extension | eq neq in not_in contains has_value | Free text | All |
country | Country | eq neq in not_in contains has_value | Free text | All |
Demographics
| Field | Label | Operators | Values | Audience types |
|---|---|---|---|---|
gender | Gender | in not_in | male female unknown | All |
age | Age | in not_in | 18-24 25-34 35-44 45-54 55-64 65+ | All |
married | Married | in not_in | yes no | All |
children | Children | in not_in | yes no | All |
income | Household income | in not_in | <20k 20-30k 30-40k 40-50k 50-75k 75-100k 100-150k 150-250k 250k+ | All |
net_worth | Net worth | in not_in | <0 0-5k 5-25k 25-100k 100-250k 250-500k 500k-1m 1m+ | All |
homeowner | Homeowner | in not_in | yes no | All |
Job
| Field | Label | Operators | Values | Audience types |
|---|---|---|---|---|
job_title | Job title | eq neq in not_in contains | Free text | All |
job_title_normalized | Job title (normalized) | eq neq in not_in contains has_value | Free text | All |
job_title_updated | Job title last updated | eq neq in not_in contains has_value | Free text | All |
seniority | Seniority | in not_in | c_suite vp director manager staff | All |
seniority_secondary | Seniority (secondary) | eq neq in not_in contains has_value | Free text | All |
department | Department | in not_in | administrative engineering executive finance marketing sales other | All |
department_secondary | Department (secondary) | eq neq in not_in contains has_value | Free text | All |
work_address_line1 | Work address | eq neq in not_in contains has_value | Free text | All |
work_address_line2 | Work address line 2 | eq neq in not_in contains has_value | Free text | All |
work_city | Work city | eq neq in not_in contains has_value | Free text | All |
work_state | Work state | eq neq in not_in contains has_value | Free text | All |
work_zip | Work ZIP code | eq neq in not_in contains has_value | Free text | All |
work_zip4 | Work ZIP+4 extension | eq neq in not_in contains has_value | Free text | All |
Company
| Field | Label | Operators | Values | Audience types |
|---|---|---|---|---|
company_name | Company | eq neq in not_in has_value contains | Free text | All |
company_domain | Company website | eq neq in not_in contains | Free text | All |
company_related_domains | Company related domains | eq neq in not_in contains has_value | Free text | All |
company_phone | Company phone | eq neq in not_in contains has_value | Free text | All |
company_sic | Company SIC code | eq neq in not_in contains has_value | Free text | All |
company_naics | Company NAICS code | eq neq in not_in contains has_value | Free text | All |
company_address | Company address | eq neq in not_in contains has_value | Free text | All |
company_city | Company city | eq neq in not_in contains has_value | Free text | All |
company_state | Company state | eq neq in not_in contains has_value | Free text | All |
company_zip | Company ZIP code | eq neq in not_in contains has_value | Free text | All |
company_country | Company country | eq neq in not_in contains has_value | Free text | All |
company_revenue | Company revenue | in not_in | <1m 1-10m 10-50m 50-100m 100-500m 500m-1b 1b+ | All |
company_size | Company size | in not_in | 1-10 11-50 51-200 201-500 501-1000 1001-5000 5001-10000 10000+ | All |
industry | Industry | eq neq in not_in contains | Free text | All |
company_updated | Company last updated | eq neq in not_in contains has_value | Free text | All |
company_description | Company description | eq neq in not_in contains has_value | Free text | People |
Contact
| Field | Label | Operators | Values | Audience types |
|---|---|---|---|---|
first_name | First name | eq neq in not_in has_value | Free text | All |
last_name | Last name | eq neq in not_in has_value | Free text | All |
email | eq neq in not_in has_value contains | Free text | All | |
other_emails | Other emails | eq neq in not_in contains has_value | Free text | All |
email_validation_status | Email validation status | eq neq in not_in contains has_value | Free text | All |
email_last_seen | Email last seen | eq neq in not_in contains has_value | Free text | All |
phone | Phone | eq neq in not_in has_value | Free text | All |
mobile_phone | Mobile phone | eq neq in not_in has_value | Free text | All |
direct_phone | Direct phone | eq neq in not_in contains has_value | Free text | All |
linkedin_url | LinkedIn URL | eq neq in not_in contains has_value | Free text | All |
social_connections | Social connections | eq neq in not_in contains has_value | Free text | All |
business_email | Business email | eq neq in not_in has_value contains | Free text | All |
other_business_emails | Other business emails | eq neq in not_in contains has_value | Free text | All |
business_email_validation_status | Business email validation status | eq neq in not_in contains has_value | Free text | All |
business_email_last_seen | Business email last seen | eq neq in not_in contains has_value | Free text | All |
Advanced
| Field | Label | Operators | Values | Audience types |
|---|---|---|---|---|
company_contact_id | Company contact ID | eq neq in not_in contains has_value | Free text | All |
lead_updated | Lead last updated | eq neq in not_in contains has_value | Free text | All |