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

Returns a new instance of KalturaReportService.



3716
3717
3718
 
# File 'lib/kaltura_client.rb', line 3716

def initialize(client)
  super(client)
end

Instance Method Details

#execute(id, params = KalturaNotImplemented) ⇒ Object 



3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
 
# File 'lib/kaltura_client.rb', line 3811

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

#get_base_total(report_type, report_input_filter, object_ids = KalturaNotImplemented) ⇒ Object

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



3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
 
# File 'lib/kaltura_client.rb', line 3751

def get_base_total(report_type, report_input_filter, object_ids=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.queue_service_action_call('report', 'getBaseTotal', 'array', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_csv(id, params = KalturaNotImplemented) ⇒ Object 



3822
3823
3824
3825
3826
3827
3828
 
# File 'lib/kaltura_client.rb', line 3822

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

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



3832
3833
3834
3835
3836
3837
3838
 
# File 'lib/kaltura_client.rb', line 3832

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

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



3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
 
# File 'lib/kaltura_client.rb', line 3722

def get_graphs(report_type, report_input_filter, dimension=KalturaNotImplemented, object_ids=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.queue_service_action_call('report', 'getGraphs', 'array', 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) ⇒ Object

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



3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
 
# File 'lib/kaltura_client.rb', line 3765

def get_table(report_type, report_input_filter, pager, order=KalturaNotImplemented, object_ids=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.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) ⇒ Object

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



3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
 
# File 'lib/kaltura_client.rb', line 3737

def get_total(report_type, report_input_filter, object_ids=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.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) ⇒ Object

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



3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
 
# File 'lib/kaltura_client.rb', line 3781

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)
  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.queue_service_action_call('report', 'getUrlForReportAsCsv', 'string', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#serve(id) ⇒ Object

Will serve a requested report



3801
3802
3803
3804
3805
3806
3807
3808
3809
 
# File 'lib/kaltura_client.rb', line 3801

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