Merge pull request #29 from DigitalTolk/custom-report-filter

feat: custom report filter

app/controllers/api/v1/accounts/csat_survey_responses_controller.rb

@@ -45,6 +45,7 @@ def set_csat_survey_responses
                                                  .filter_by_inbox_id(params[:inbox_id])
                                                  .filter_by_team_id(params[:team_id])
                                                  .filter_by_rating(params[:rating])
+                                                 .filter_by_label(params[:label])
   end
 
   def set_current_page_surveys

app/controllers/api/v2/accounts/reports_controller.rb

@@ -76,7 +76,8 @@ def common_params
       type: params[:type].to_sym,
       id: params[:id],
       group_by: params[:group_by],
-      business_hours: ActiveModel::Type::Boolean.new.cast(params[:business_hours])
+      business_hours: ActiveModel::Type::Boolean.new.cast(params[:business_hours]),
+      custom_filter: params[:custom_filter]
     }
   end
 

app/helpers/report_helper.rb

@@ -16,6 +16,104 @@ def scope
     end
   end
 
+  def custom_filter(collection)
+    return collection if collection.blank?
+
+    case collection.model_name.name
+    when 'Conversation'
+      filter_conversations(collection)
+    when 'Message'
+      filter_messages(collection)
+    when 'ReportingEvent'
+      filter_reporting_events(collection)
+    else
+      collection
+    end
+  end
+
+  def get_filter(key, field)
+    filter = params.dig(:custom_filter, key)
+    return [] unless filter.present?
+
+    filter.to_unsafe_h.values
+  end
+
+  def selected_label
+    get_filter(:selected_label, :title)
+  end
+
+  def selected_team
+    get_filter(:selected_team, :id)
+  end
+
+  def selected_inbox
+    get_filter(:selected_inbox, :id)
+  end
+
+  def selected_rating
+    get_filter(:selected_rating, :value)
+  end
+
+  def filter_conversations(collection)
+    if selected_label.present?
+      collection = collection.where(cached_label_list: selected_label)
+    end
+
+    if selected_team.present?
+      collection = collection.where(team_id: selected_team)
+    end
+
+    if selected_inbox.present?
+      collection = collection.where(inbox_id: selected_inbox)
+    end
+
+    if selected_rating.present?
+      collection = collection.joins(:csat_survey_responses).where(csat_survey_responses: {rating: selected_rating}).distinct
+    end
+
+    collection
+  end
+
+  def filter_messages(collection)
+    if selected_label.present?
+      collection = collection.joins(:conversation).where(conversations: {cached_label_list: selected_label})
+    end
+
+    if selected_team.present?
+      collection = collection.joins(:conversation).where(conversations: {team_id: selected_team})
+    end
+
+    if selected_inbox.present?
+      collection = collection.where(inbox_id: selected_inbox)
+    end
+
+    if selected_rating.present?
+      collection = collection.joins(conversation: :csat_survey_responses).where(csat_survey_responses: {rating: selected_rating}).distinct
+    end
+
+    collection
+  end
+
+  def filter_reporting_events(collection)
+    if selected_label.present?
+      collection = collection.joins(:conversation).where(conversations: {cached_label_list: selected_label})
+    end
+
+    if selected_team.present?
+      collection = collection.joins(:conversation).where(conversations: {team_id: selected_team})
+    end
+
+    if selected_inbox.present?
+      collection = collection.where(inbox_id: selected_inbox)
+    end
+
+    if selected_rating.present?
+      collection = collection.joins(conversation: :csat_survey_responses).where(csat_survey_responses: {rating: selected_rating}).distinct
+    end
+
+    collection
+  end
+
   def conversations_count
     (get_grouped_values conversations).count
   end
@@ -41,55 +139,55 @@ def bot_handoffs_count
   end
 
   def conversations
-    scope.conversations.where(account_id: account.id, created_at: range)
+    custom_filter(scope.conversations).where(account_id: account.id, created_at: range)
   end
 
   def incoming_messages
-    scope.messages.where(account_id: account.id, created_at: range).incoming.unscope(:order)
+    custom_filter(scope.messages).where(account_id: account.id, created_at: range).incoming.unscope(:order)
   end
 
   def outgoing_messages
-    scope.messages.where(account_id: account.id, created_at: range).outgoing.unscope(:order)
+    custom_filter(scope.messages).where(account_id: account.id, created_at: range).outgoing.unscope(:order)
   end
 
   def resolutions
-    scope.reporting_events.joins(:conversation).select(:conversation_id).where(account_id: account.id, name: :conversation_resolved,
+    custom_filter(scope.reporting_events).joins(:conversation).select(:conversation_id).where(account_id: account.id, name: :conversation_resolved,
                                                                                conversations: { status: :resolved }, created_at: range).distinct
   end
 
   def bot_resolutions
-    scope.reporting_events.joins(:conversation).select(:conversation_id).where(account_id: account.id, name: :conversation_bot_resolved,
+    custom_filter(scope.reporting_events).joins(:conversation).select(:conversation_id).where(account_id: account.id, name: :conversation_bot_resolved,
                                                                                conversations: { status: :resolved }, created_at: range).distinct
   end
 
   def bot_handoffs
-    scope.reporting_events.joins(:conversation).select(:conversation_id).where(account_id: account.id, name: :conversation_bot_handoff,
+    custom_filter(scope.reporting_events).joins(:conversation).select(:conversation_id).where(account_id: account.id, name: :conversation_bot_handoff,
                                                                                created_at: range).distinct
   end
 
   def avg_first_response_time
-    grouped_reporting_events = (get_grouped_values scope.reporting_events.where(name: 'first_response', account_id: account.id))
+    grouped_reporting_events = (get_grouped_values custom_filter(scope.reporting_events).where(name: 'first_response', account_id: account.id))
     return grouped_reporting_events.average(:value_in_business_hours) if params[:business_hours]
 
     grouped_reporting_events.average(:value)
   end
 
   def reply_time
-    grouped_reporting_events = (get_grouped_values scope.reporting_events.where(name: 'reply_time', account_id: account.id))
+    grouped_reporting_events = (get_grouped_values custom_filter(scope.reporting_events).where(name: 'reply_time', account_id: account.id))
     return grouped_reporting_events.average(:value_in_business_hours) if params[:business_hours]
 
     grouped_reporting_events.average(:value)
   end
 
   def avg_resolution_time
-    grouped_reporting_events = (get_grouped_values scope.reporting_events.where(name: 'conversation_resolved', account_id: account.id))
+    grouped_reporting_events = (get_grouped_values custom_filter(scope.reporting_events).where(name: 'conversation_resolved', account_id: account.id))
     return grouped_reporting_events.average(:value_in_business_hours) if params[:business_hours]
 
     grouped_reporting_events.average(:value)
   end
 
   def avg_resolution_time_summary
-    reporting_events = scope.reporting_events
+    reporting_events = custom_filter(scope.reporting_events)
                             .where(name: 'conversation_resolved', account_id: account.id, created_at: range)
     avg_rt = if params[:business_hours].present?
                reporting_events.average(:value_in_business_hours)
@@ -103,7 +201,7 @@ def avg_resolution_time_summary
   end
 
   def reply_time_summary
-    reporting_events = scope.reporting_events
+    reporting_events = custom_filter(scope.reporting_events)
                             .where(name: 'reply_time', account_id: account.id, created_at: range)
     reply_time = params[:business_hours] ? reporting_events.average(:value_in_business_hours) : reporting_events.average(:value)
 
@@ -113,7 +211,7 @@ def reply_time_summary
   end
 
   def avg_first_response_time_summary
-    reporting_events = scope.reporting_events
+    reporting_events = custom_filter(scope.reporting_events)
                             .where(name: 'first_response', account_id: account.id, created_at: range)
     avg_frt = if params[:business_hours].present?
                 reporting_events.average(:value_in_business_hours)

app/javascript/dashboard/api/csatReports.js

@@ -15,6 +15,7 @@ class CSATReportsAPI extends ApiClient {
     team_id,
     rating,
     question_id,
+    label,
   } = {}) {
     return axios.get(this.url, {
       params: {
@@ -27,11 +28,12 @@ class CSATReportsAPI extends ApiClient {
         team_id,
         rating,
         question_id,
+        label,
       },
     });
   }
 
-  getQuestions({ from, to, user_ids, inbox_id, team_id, rating } = {}) {
+  getQuestions({ from, to, user_ids, inbox_id, team_id, rating, label } = {}) {
     return axios.get(`${this.url}/questions`, {
       params: {
         since: from,
@@ -41,11 +43,12 @@ class CSATReportsAPI extends ApiClient {
         inbox_id,
         team_id,
         rating,
+        label
       },
     });
   }
 
-  download({ from, to, user_ids, inbox_id, team_id, rating } = {}) {
+  download({ from, to, user_ids, inbox_id, team_id, rating, label } = {}) {
     return axios.get(`${this.url}/download`, {
       params: {
         since: from,
@@ -55,14 +58,15 @@ class CSATReportsAPI extends ApiClient {
         inbox_id,
         team_id,
         rating,
+        label
       },
     });
   }
 
-  getMetrics({ from, to, user_ids, inbox_id, team_id, rating } = {}) {
+  getMetrics({ from, to, user_ids, inbox_id, team_id, rating, label } = {}) {
     // no ratings for metrics
     return axios.get(`${this.url}/metrics`, {
-      params: { since: from, until: to, user_ids, inbox_id, team_id, rating },
+      params: { since: from, until: to, user_ids, inbox_id, team_id, rating, label },
     });
   }
 }

app/javascript/dashboard/api/reports.js

@@ -13,6 +13,10 @@ class ReportsAPI extends ApiClient {
     from,
     to,
     type = 'account',
+    selectedLabel,
+    selectedTeam,
+    selectedInbox,
+    selectedRating,
     id,
     groupBy,
     businessHours,
@@ -22,6 +26,12 @@ class ReportsAPI extends ApiClient {
         metric,
         since: from,
         until: to,
+        custom_filter: {
+          selected_label: selectedLabel,
+          selected_team: selectedTeam,
+          selected_inbox: selectedInbox,
+          selected_rating: selectedRating
+        },
         type,
         id,
         group_by: groupBy,
@@ -32,11 +42,17 @@ class ReportsAPI extends ApiClient {
   }
 
   // eslint-disable-next-line default-param-last
-  getSummary(since, until, type = 'account', id, groupBy, businessHours) {
+  getSummary(since, until, type = 'account', selectedLabel, selectedTeam, selectedInbox, selectedRating, id, groupBy, businessHours) {
     return axios.get(`${this.url}/summary`, {
       params: {
         since,
         until,
+        custom_filter: {
+          selected_label: selectedLabel,
+          selected_team: selectedTeam,
+          selected_inbox: selectedInbox,
+          selected_rating: selectedRating
+        },
         type,
         id,
         group_by: groupBy,

app/javascript/dashboard/routes/dashboard/settings/reports/CsatResponses.vue

@@ -4,9 +4,14 @@
       :show-agents-filter="true"
       :show-inbox-filter="true"
       :show-rating-filter="true"
+      :show-labels-filter="true"
       :show-team-filter="isTeamsEnabled"
       :show-business-hours-switch="false"
       @filter-change="onFilterChange"
+      :multiple-labels="true"
+      :multiple-teams="true"
+      :multiple-inboxes="true"
+      :multiple-ratings="true"
     />
     <woot-button
       color-scheme="success"
@@ -55,9 +60,10 @@ export default {
       from: 0,
       to: 0,
       userIds: [],
-      inbox: null,
-      team: null,
-      rating: null,
+      inbox: [],
+      team: [],
+      rating: [],
+      label: [],
       groudByQuestions: false,
     };
   },
@@ -74,6 +80,7 @@ export default {
         inbox_id: this.inbox,
         team_id: this.team,
         rating: this.rating,
+        label: this.label,
       };
     },
     isTeamsEnabled() {
@@ -121,6 +128,7 @@ export default {
       selectedInbox,
       selectedTeam,
       selectedRating,
+      selectedLabel
     }) {
       // do not track filter change on inital load
       if (this.from !== 0 && this.to !== 0) {
@@ -132,10 +140,11 @@ export default {
 
       this.from = from;
       this.to = to;
-      this.userIds = selectedAgents.map(el => el.id);
-      this.inbox = selectedInbox?.id;
-      this.team = selectedTeam?.id;
-      this.rating = selectedRating?.value;
+      this.userIds = selectedAgents && selectedAgents.map(el => el.id);
+      this.inbox = selectedInbox &&selectedInbox.map(el => el.id);
+      this.team = selectedTeam && selectedTeam.map(el => el.id);
+      this.rating = selectedRating && selectedRating.map(el => el.value);
+      this.label =  selectedLabel && selectedLabel.map(el => el.title);
 
       this.getAllData();
     },