Introduction

In this lab we will be exploring how to add filters to your query.

Prerequisites

• Complete Getting Started
• Complete Exploring the Query

Lab Objective

• Understand the available filter criteria
• Understand criteria grouping
• Ability to identify available filter criteria
• Create a basic filter
• Create a grouped filter

Available Filters Types

1. Strings - scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
2. Comparisons
   • equals - Returns data if the value equals the criteria
   • notequals - Returns all other data than the values which equal the criteria
   • contains - Returns data if the value contains a sub-string given for the criteria. (Can use RegEx)
   • match - Returns data if the criteria matches a pattern. (Can use RegEx)
3. Boolean - true/false
4. Integer - scalar type represents non-fractional signed whole numeric values
5. Comparisons
   • equals - Returns data if the value equals the criteria
   • notequals - Returns all other data than the values which equal the criteria
   • gt - greater than
   • gte - greater than or equal to
   • lt - less than
   • lte - less than or equal to
6. Enumerations - scalar type represents a predefined list of values. Similar to a string, but does not accept quotes.
7. Comparisons
   • equals - Returns data if the value equals the criteria
   • notequals - Returns all other data than the values which equal the criteria

Filter Grouping

While single filters can be useful, it is common to need more that one filter to return the data you are looking for. The grouping filters are "and", "or", and "not". They can be used by themselves to group one or more filters or in conjunction with each other to create more complex filters.

Adding our first filter

1. Click + Add new in the top bar of Altair

   

2. Copy the query from the "Exploring the Query" lab.

   { task( from: " ___ " to: " ___ " timeComparator: createdTime # filter: # aggregation: # aggregations: [{ field: "string", type: count, name: "string" }] # aggregationInterval: { interval: FIFTEEN_MINUTES } # pagination: ) { tasks { id status channelType createdTime endedTime origin destination contactReason direction owner { id name signInId sessionId phoneNumber channelId } terminationType channelSubType customer { name phoneNumber email } isActive isCallback channelMetaData { email { subject metaData } chat { chatReason } inBoundTranscript outBoundTranscript } callbackData { callbackRequestTime callbackConnectTime callbackNumber callbackStatus callbackOrigin callbackType callbackQueueName callbackAgentName callbackTeamName callbackRetryCount } recordingLocation lastWrapupCodeName lastQueue { id name duration } lastSite { id name } lastTeam { id name } lastEntryPoint { id name } previousQueue { id name } totalDuration csatScore blindTransferCount conferenceCount conferenceDuration consultCount consultDuration holdCount holdDuration selfserviceCount selfserviceDuration connectedCount connectedDuration consultToQueueCount consultToQueueDuration transferCount wrapupDuration ringingDuration queueDuration queueCount captureRequested isTranscriptionAvailable consultToEPCount consultToEPDuration outdialConsultToEPCount outdialConsultToEPDuration agentToDnTransferCount agentToAgentTransferCount callCompletedCount sentiment autoCsat outdialConsultToQueueCount outdialConsultCount # integerGlobalVariables(name: "string") # stringGlobalVariables(name: "string") # longGlobalVariables(name: "string") # doubleGlobalVariables(name: "string") # booleanGlobalVariables(name: "string") # intervalStartTime # aggregation }</p> <p>pageInfo { endCursor hasNextPage } intervalInfo { interval timezone } } }

3. Uncomment "filter:"

4. Next to "filter:" add { channelType: { equals: telephony } }
5. Send the request
6. Open the Docs panel
7. Navigate Query > task > filter > ChannelTypeExpression (do not click channelType as it will not show you the next level of information) > (next to equals) ChannelTypes
8. Note that this is an enum filter type
9. In the Docs panel, click the back button until you get back to TaskFilters
10. Navigate to terminiationType
    • What type of filter is terminationType?

      String
11. Before we can add this filter to our query, we need to create an "and" group. Add the "and" group like this. and: [ { channelType: { equals: telephony } } ]
12. Below the channelType filter and still inside the and brackets, add a filter for terminationType to equal "normal".

    { terminationType: { equals: "normal" } }
13. Send the request.
    • You should only have records returned which were both from the telephony channelType and had a "normal" terminationType

    • What if you wanted to see all calls which did not terminate normally?

      you could change "equals" to "notequals" { terminationType: { notequals: "normal" } }

      OR you could place the filter in a "not" group filter

      { not: { terminationType: { equals: "normal" } } }

      3. Change your filters to return calls which did not have a terminiationType of "normal" - What terminationTypes are returned?

⚠️ Note that the use of the "not" group filter will be evaluated differently based on placement.

• This filter will evaluate as not channelType email AND not isActive false and will return every record that matches both criteria

  filter: { and: [ { not: { channelType: { equals: email } } } { not: { isActive: { equals: false } } } ] }

• This filter will evaluate as not channelType email AND not isActive false and return every record that does not match both criteria

  filter: { not: { and: [ { channelType: { equals: email } } { isActive: { equals: false } } ] } }

Click Next to continue to the next lesson