Class: Kaltura::KalturaReportService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

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

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaReportService 



3847
3848
3849
 
# File 'lib/kaltura_client.rb', line 3847

def initialize(client)
  super(client)
end

Instance Method Details

#execute(id, params = KalturaNotImplemented) ⇒ KalturaReportResponse 



3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
 
# File 'lib/kaltura_client.rb', line 3852

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) ⇒ KalturaReportExportResponse 



3864
3865
3866
3867
3868
3869
3870
3871
3872
 
# File 'lib/kaltura_client.rb', line 3864

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) ⇒ array

report getBaseTotal action allows to get the total base for storage reports



3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
 
# File 'lib/kaltura_client.rb', line 3876

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) ⇒ file 



3890
3891
3892
3893
3894
3895
3896
 
# File 'lib/kaltura_client.rb', line 3890

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) ⇒ file

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



3900
3901
3902
3903
3904
3905
3906
 
# File 'lib/kaltura_client.rb', line 3900

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) ⇒ array

report getGraphs action allows to get a graph data for a specific report.



3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
 
# File 'lib/kaltura_client.rb', line 3910

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) ⇒ KalturaReportTable

report getTable action allows to get a graph data for a specific report.



3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
 
# File 'lib/kaltura_client.rb', line 3926

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) ⇒ KalturaReportTotal

report getTotal action allows to get a graph data for a specific report.



3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
 
# File 'lib/kaltura_client.rb', line 3943

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) ⇒ string

will create a CSV file for the given report and return the URL to access it



3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
 
# File 'lib/kaltura_client.rb', line 3958

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) ⇒ string

Will serve a requested report



3979
3980
3981
3982
3983
3984
3985
3986
3987
 
# File 'lib/kaltura_client.rb', line 3979

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