Read filter syntax

The following table details the syntax to use when filling out filter parameters (that is, f and fm) in Coveo Usage Analytics (Coveo UA) Read API requests.

Symbol Operation Example


Equals (case insensitive)

originlevel1 =~ "agentcasepanel"


Not equal (case insensitive)

originlevel1 !~ "agentcasepanel"


Equals (case sensitive)

originlevel1 == "AgentCasePanel"


Not equal (case sensitive)

originlevel1 != "AgentCasePanel"


Contains (case insensitive)

originlevel1 =@ "Agent"


Does not contain (case insensitive)

originlevel1 !@ "Agent"


Less than

PerformSearch < 100


Less than or equal to

PerformSearch <= 100


Greater than

PerformSearch > 100


Greater than or equal to

PerformSearch >= 100


In array (case sensitive)

originlevel1 IN ["AgentCasePanel","InsightPanel"]


Not in array (case sensitive)

originlevel1 NOT_IN ["AgentCasePanel","InsightPanel"]


Logical AND

(groupname!=null) AND (originlevel1 IN ["AgentCasePanel","InsightPanel"])


Logical OR

(groupname!=null) OR (originlevel1 IN ["AgentCasePanel","InsightPanel"])

  • AND applies by default when you send several f or fm parameters.

    For example, appending &f=groupname!=null&f= originlevel1 IN ["AgentCasePanel","InsightPanel"] to your query string is equal to appending &f=(groupname!=null) AND (origin level 1 IN ["AgentCasePanel","InsightPanel"]) to your query string.

  • You can use either single (for example, 'Agent') or double (for example, "Agent") quotes to delimit strings.

  • To escape a quote in a string, use \.