Getting started with Carrot

Carrot (Carrot Query Language) is the most powerful way to search, create and reference data across your ChartHop organization using custom or built-in functions and filters.

With Carrot you can:

One of Carrot's greatest values comes from its ability to enable users to build advanced structured queries, filters, and smart fields that perform calculations.

A simple query in Carrot consists of a field, followed by an operator, followed by one or more values or functions. For example:

This query will find all ChartHop users in the organization with the job title of "Director of Engineering". In this case, the query uses the title field, the EQUALS operator, and the value Director of Engineering.

For more complex queries, operators can be used to filter data by more than one criteria. For example:

This query will find all ChartHop users in the organization with "director" somewhere in their job title and who started working before the date of January 1st, 2020. In this case, the query uses the title field, the : operator which functions as a Fuzzy search, and the value director as the first half of the query. Then, followed by the &&(AND) operator the query includes the startDate field, followed by the LESS THAN operator, and then the value '2020-01-01'

Dive deeper into Carrot's structure in our Key Concepts article.

The below examples illustrate how you might use Carrot when creating filters, queries, custom fields, and more.

All data access in Carrot is permission controlled, according to ChartHop Access Levels, and so query results may vary between users depending on their level of permissions.