# Pull Request Template ## Description This PR adds support for exporting conversation summary reports as CSV. Previously, the Conversations report incorrectly showed an option to download agent reports; this has now been fixed to export conversation-level data instead. Fixes https://linear.app/chatwoot/issue/CW-6176/conversation-reports-export-button-exports-agent-reports-instead ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? ### Screenshot <img width="1859" height="1154" alt="image" src="https://github.com/user-attachments/assets/419d26f4-fda9-4782-aea6-55ffad0c37ab" /> ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
143 lines
3.9 KiB
Ruby
143 lines
3.9 KiB
Ruby
class Api::V2::Accounts::ReportsController < Api::V1::Accounts::BaseController
|
|
include Api::V2::Accounts::ReportsHelper
|
|
include Api::V2::Accounts::HeatmapHelper
|
|
|
|
before_action :check_authorization
|
|
|
|
def index
|
|
builder = V2::Reports::Conversations::ReportBuilder.new(Current.account, report_params)
|
|
data = builder.timeseries
|
|
render json: data
|
|
end
|
|
|
|
def summary
|
|
render json: build_summary(:summary)
|
|
end
|
|
|
|
def bot_summary
|
|
render json: build_summary(:bot_summary)
|
|
end
|
|
|
|
def agents
|
|
@report_data = generate_agents_report
|
|
generate_csv('agents_report', 'api/v2/accounts/reports/agents')
|
|
end
|
|
|
|
def inboxes
|
|
@report_data = generate_inboxes_report
|
|
generate_csv('inboxes_report', 'api/v2/accounts/reports/inboxes')
|
|
end
|
|
|
|
def labels
|
|
@report_data = generate_labels_report
|
|
generate_csv('labels_report', 'api/v2/accounts/reports/labels')
|
|
end
|
|
|
|
def teams
|
|
@report_data = generate_teams_report
|
|
generate_csv('teams_report', 'api/v2/accounts/reports/teams')
|
|
end
|
|
|
|
def conversations_summary
|
|
@report_data = generate_conversations_report
|
|
generate_csv('conversations_summary_report', 'api/v2/accounts/reports/conversations_summary')
|
|
end
|
|
|
|
def conversation_traffic
|
|
@report_data = generate_conversations_heatmap_report
|
|
timezone_offset = (params[:timezone_offset] || 0).to_f
|
|
@timezone = ActiveSupport::TimeZone[timezone_offset]
|
|
|
|
generate_csv('conversation_traffic_reports', 'api/v2/accounts/reports/conversation_traffic')
|
|
end
|
|
|
|
def conversations
|
|
return head :unprocessable_entity if params[:type].blank?
|
|
|
|
render json: conversation_metrics
|
|
end
|
|
|
|
def bot_metrics
|
|
bot_metrics = V2::Reports::BotMetricsBuilder.new(Current.account, params).metrics
|
|
render json: bot_metrics
|
|
end
|
|
|
|
private
|
|
|
|
def generate_csv(filename, template)
|
|
response.headers['Content-Type'] = 'text/csv'
|
|
response.headers['Content-Disposition'] = "attachment; filename=#{filename}.csv"
|
|
render layout: false, template: template, formats: [:csv]
|
|
end
|
|
|
|
def check_authorization
|
|
authorize :report, :view?
|
|
end
|
|
|
|
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])
|
|
}
|
|
end
|
|
|
|
def current_summary_params
|
|
common_params.merge({
|
|
since: range[:current][:since],
|
|
until: range[:current][:until],
|
|
timezone_offset: params[:timezone_offset]
|
|
})
|
|
end
|
|
|
|
def previous_summary_params
|
|
common_params.merge({
|
|
since: range[:previous][:since],
|
|
until: range[:previous][:until],
|
|
timezone_offset: params[:timezone_offset]
|
|
})
|
|
end
|
|
|
|
def report_params
|
|
common_params.merge({
|
|
metric: params[:metric],
|
|
since: params[:since],
|
|
until: params[:until],
|
|
timezone_offset: params[:timezone_offset]
|
|
})
|
|
end
|
|
|
|
def conversation_params
|
|
{
|
|
type: params[:type].to_sym,
|
|
user_id: params[:user_id],
|
|
page: params[:page].presence || 1
|
|
}
|
|
end
|
|
|
|
def range
|
|
{
|
|
current: {
|
|
since: params[:since],
|
|
until: params[:until]
|
|
},
|
|
previous: {
|
|
since: (params[:since].to_i - (params[:until].to_i - params[:since].to_i)).to_s,
|
|
until: params[:since]
|
|
}
|
|
}
|
|
end
|
|
|
|
def build_summary(method)
|
|
builder = V2::Reports::Conversations::MetricBuilder
|
|
current_summary = builder.new(Current.account, current_summary_params).send(method)
|
|
previous_summary = builder.new(Current.account, previous_summary_params).send(method)
|
|
current_summary.merge(previous: previous_summary)
|
|
end
|
|
|
|
def conversation_metrics
|
|
V2::ReportBuilder.new(Current.account, conversation_params).conversation_metrics
|
|
end
|
|
end
|