class Kaltura::KalturaReportService

api for getting reports data by the report type and some inputFilter

Public Class Methods

new(client) click to toggle source
Calls superclass method
# File lib/kaltura_client.rb, line 3915
def initialize(client)
        super(client)
end

Public Instance Methods

execute(id, params=KalturaNotImplemented) click to toggle source

@return [KalturaReportResponse]

# File lib/kaltura_client.rb, line 3920
def execute(id, params=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'params', params)
        client.queue_service_action_call('report', 'execute', 'KalturaReportResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
export_to_csv(params) click to toggle source

@return [KalturaReportExportResponse]

# File lib/kaltura_client.rb, line 3932
def export_to_csv(params)
        kparams = {}
        client.add_param(kparams, 'params', params)
        client.queue_service_action_call('report', 'exportToCsv', 'KalturaReportExportResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_base_total(report_type, report_input_filter, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented) click to toggle source

report getBaseTotal action allows to get the total base for storage reports @return [array]

# File lib/kaltura_client.rb, line 3944
def get_base_total(report_type, report_input_filter, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'reportType', report_type)
        client.add_param(kparams, 'reportInputFilter', report_input_filter)
        client.add_param(kparams, 'objectIds', object_ids)
        client.add_param(kparams, 'responseOptions', response_options)
        client.queue_service_action_call('report', 'getBaseTotal', 'KalturaReportBaseTotal', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_csv(id, params=KalturaNotImplemented) click to toggle source

@return [file]

# File lib/kaltura_client.rb, line 3958
def get_csv(id, params=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'params', params)
        client.queue_service_action_call('report', 'getCsv', 'file', kparams)
        return client.get_serve_url()
end
get_csv_from_string_params(id, params=KalturaNotImplemented) click to toggle source

Returns report CSV file executed by string params with the following convention: param1=value1;param2=value2 @return [file]

# File lib/kaltura_client.rb, line 3968
def get_csv_from_string_params(id, params=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'params', params)
        client.queue_service_action_call('report', 'getCsvFromStringParams', 'file', kparams)
        return client.get_serve_url()
end
get_graphs(report_type, report_input_filter, dimension=KalturaNotImplemented, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented) click to toggle source

report getGraphs action allows to get a graph data for a specific report. @return [array]

# File lib/kaltura_client.rb, line 3978
def get_graphs(report_type, report_input_filter, dimension=KalturaNotImplemented, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'reportType', report_type)
        client.add_param(kparams, 'reportInputFilter', report_input_filter)
        client.add_param(kparams, 'dimension', dimension)
        client.add_param(kparams, 'objectIds', object_ids)
        client.add_param(kparams, 'responseOptions', response_options)
        client.queue_service_action_call('report', 'getGraphs', 'KalturaReportGraph', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_table(report_type, report_input_filter, pager, order=KalturaNotImplemented, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented) click to toggle source

report getTable action allows to get a graph data for a specific report. @return [KalturaReportTable]

# File lib/kaltura_client.rb, line 3994
def get_table(report_type, report_input_filter, pager, order=KalturaNotImplemented, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'reportType', report_type)
        client.add_param(kparams, 'reportInputFilter', report_input_filter)
        client.add_param(kparams, 'pager', pager)
        client.add_param(kparams, 'order', order)
        client.add_param(kparams, 'objectIds', object_ids)
        client.add_param(kparams, 'responseOptions', response_options)
        client.queue_service_action_call('report', 'getTable', 'KalturaReportTable', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_total(report_type, report_input_filter, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented) click to toggle source

report getTotal action allows to get a graph data for a specific report. @return [KalturaReportTotal]

# File lib/kaltura_client.rb, line 4011
def get_total(report_type, report_input_filter, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'reportType', report_type)
        client.add_param(kparams, 'reportInputFilter', report_input_filter)
        client.add_param(kparams, 'objectIds', object_ids)
        client.add_param(kparams, 'responseOptions', response_options)
        client.queue_service_action_call('report', 'getTotal', 'KalturaReportTotal', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_url_for_report_as_csv(report_title, report_text, headers, report_type, report_input_filter, dimension=KalturaNotImplemented, pager=KalturaNotImplemented, order=KalturaNotImplemented, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented) click to toggle source

will create a CSV file for the given report and return the URL to access it @return [string]

# File lib/kaltura_client.rb, line 4026
def get_url_for_report_as_csv(report_title, report_text, headers, report_type, report_input_filter, dimension=KalturaNotImplemented, pager=KalturaNotImplemented, order=KalturaNotImplemented, object_ids=KalturaNotImplemented, response_options=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'reportTitle', report_title)
        client.add_param(kparams, 'reportText', report_text)
        client.add_param(kparams, 'headers', headers)
        client.add_param(kparams, 'reportType', report_type)
        client.add_param(kparams, 'reportInputFilter', report_input_filter)
        client.add_param(kparams, 'dimension', dimension)
        client.add_param(kparams, 'pager', pager)
        client.add_param(kparams, 'order', order)
        client.add_param(kparams, 'objectIds', object_ids)
        client.add_param(kparams, 'responseOptions', response_options)
        client.queue_service_action_call('report', 'getUrlForReportAsCsv', 'string', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
serve(id) click to toggle source

Will serve a requested report @return [string]

# File lib/kaltura_client.rb, line 4047
def serve(id)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.queue_service_action_call('report', 'serve', 'string', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end