CareChannel filter DSL
One JSON grammar filters posts (search_posts, saved views, roadmaps, bulk_update_posts) and users (segments).
Shape
- A condition:
{ "field": "votes", "op": "gte", "value": 10 }. - Groups:
{ "all": [...] }(AND),{ "any": [...] }(OR),{ "not": {...} }. Up to 3 levels deep and 50 conditions. inandnintake a list (up to 100 values);betweentakes[low, high];existstakes true or false;within_daystakes a number of days.- Dates are ISO 8601 (
2027-03-01). Names, slugs and emails work wherever an ID does. - Errors name the offending path and list the valid fields or operators.
Example
Open or in-progress Feature Requests with 10+ votes or any must-have vote:
{
"all": [
{
"field": "board",
"op": "eq",
"value": "feature-requests"
},
{
"field": "status_type",
"op": "in",
"value": [
"open",
"active"
]
},
{
"any": [
{
"field": "votes",
"op": "gte",
"value": 10
},
{
"field": "votes_priority.must_have",
"op": "gte",
"value": 1
}
]
}
]
}
Post fields
text(contains): Words in the title or body (full-text search).board(eq, neq, in, nin): Board slug, name or ID.category(eq, neq, in, nin, exists): Category name, slug or ID; exists: false for posts without one.status(eq, neq, in, nin): Status name or ID.status_type(eq, neq, in, nin): The status's type. Values: open, active, complete, closed.author(eq, neq, in, nin): End user or member ID, or an email.moderation_state(eq, neq, in, nin): Moderation state; end users only ever see approved posts and their own. Values: approved, pending, rejected, spam.tag(eq, neq, in, nin): Tag name or ID (team only).owner(eq, neq, in, nin): Owner's member ID or email (team only).has_owner(eq): true: has an owner; false: unassigned (team only).on_roadmap(eq, neq, in, nin, exists): An internal roadmap the post is on: name or ID; exists: true/false for any roadmap (team only).eta(gt, gte, lt, lte, between, within_days, exists): Expected delivery date (first day of its month or quarter).author_company(eq, neq, in, nin): The author's company: ID, external ID or name (team only).voter_company(eq, neq, in, nin): A company with at least one voter on the post: ID, external ID or name (team only).voter_segment(eq, neq, in, nin): A segment with at least one voter on the post: ID or name (team only).mrr_at_stake(eq, neq, gt, gte, lt, lte, between): Summed MRR of the distinct companies of the post's voters (team only).votes(eq, neq, gt, gte, lt, lte, between): Vote count.comments(eq, neq, gt, gte, lt, lte, between): Comment count.created_at(gt, gte, lt, lte, between, within_days): When the post was created.updated_at(gt, gte, lt, lte, between, within_days): When the post was last edited.status_changed_at(gt, gte, lt, lte, between, within_days): When the status last changed.custom.<key>(eq, neq, in, nin, gt, gte, lt, lte, between, contains, exists, within_days): A post custom field by key; operators depend on its type.votes_priority.<key>(eq, neq, gt, gte, lt, lte, between): Number of votes at that priority (team only). Keys: none, nice_to_have, important, must_have.
User fields (segments)
email(eq, neq, in, nin, contains): The user's email.email_domain(eq, neq, in, nin, contains): The part after @, such as "globex.com".company(eq, neq, in, nin): A company the user belongs to: ID, external ID or name.mrr(eq, neq, gt, gte, lt, lte, between, exists): MRR of a company the user belongs to.renewal_date(gt, gte, lt, lte, between, within_days, exists): Renewal date of a company the user belongs to.renewal_risk(eq, neq, in, nin, exists): Renewal risk of a company the user belongs to. Values: low, medium, high.created_at(gt, gte, lt, lte, between, within_days): When the user was added.last_active_at(gt, gte, lt, lte, between, within_days, exists): When the user was last active on the portal.attr.<key>(eq, neq, in, nin, gt, gte, lt, lte, between, contains, exists, within_days): A user attribute by key (company attributes: company.<key> isn't supported).