Usage Analytics Read Filter Syntax

The following table details the syntax to use when filling out filter parameters (i.e., 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 In array (case sensitive) originlevel1 IN ["AgentCasePanel","InsightPanel"]
NOT_IN Not in array (case sensitive) originlevel1 NOT_IN ["AgentCasePanel","InsightPanel"]
AND Logical AND (groupname!=null) AND (originlevel1 IN ["AgentCasePanel","InsightPanel"])
OR Logical OR (groupname!=null) OR (originlevel1 IN ["AgentCasePanel","InsightPanel"])
  • AND applies by default when you send several f or fm parameters.

    Appending &f=groupname!=null&f= originlevel1 IN ["AgentCasePanel","InsightPanel"] to your query string is equivalent to appending &f=(groupname!=null) AND (originlevel1 IN ["AgentCasePanel","InsightPanel"]) to your query string.

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

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

Recommended Articles