UltracartClient::DatawarehouseApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method	HTTP request	Description
analyze_custom_report	PUT /datawarehouse/custom_reports/{custom_report_oid}/analysis	Analyze a custom report
delete_custom_dashboard	DELETE /datawarehouse/custom_dashboards/{custom_dashboard_oid}	Delete a custom dashboard
delete_custom_dashboard_schedule	DELETE /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}	Delete a custom dashboard schedule
delete_custom_report	DELETE /datawarehouse/custom_reports/{custom_report_oid}	Delete a custom report
delete_report	DELETE /datawarehouse/reports/{report_oid}	Delete a report
dry_run_report_queries	PUT /datawarehouse/reports/dryrun	Dry run the report queries
execute_custom_report	PUT /datawarehouse/custom_reports/{custom_report_oid}/execute	Execute a custom report
execute_custom_reports	PUT /datawarehouse/custom_reports/execute	Execute a custom reports
execute_report_queries	PUT /datawarehouse/reports/execute	Execute the report queries
get_custom_dashboard	GET /datawarehouse/custom_dashboards/{custom_dashboard_oid}	Get a custom dashboard
get_custom_dashboard_schedules	GET /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules	Get custom dashboards
get_custom_dashboards	GET /datawarehouse/custom_dashboards	Get custom dashboards
get_custom_report	GET /datawarehouse/custom_reports/{custom_report_oid}	Get a custom report
get_custom_report_account_config	GET /datawarehouse/custom_reports/account_config	Get custom report account configuration
get_custom_report_chart_png_upload_url	GET /datawarehouse/custom_reports/{custom_report_oid}/chart_png	Upload a PNG of a custom report chart
get_custom_reports	GET /datawarehouse/custom_reports	Get custom reports
get_report	GET /datawarehouse/reports/{report_oid}	Get a report
get_report_data_set	GET /datawarehouse/reports/dataset/{dataset_uuid}	Get a report data set
get_report_data_set_page	GET /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number}	Get a report data set page
get_report_websocket_authorization	PUT /datawarehouse/reports/auth	Get report websocket authorization
get_reports	GET /datawarehouse/reports	Get list of reports available
insert_custom_dashboard	POST /datawarehouse/custom_dashboards	Create a custom dashboard
insert_custom_dashboard_schedule	POST /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules	Create a custom dashboard schedule
insert_custom_report	POST /datawarehouse/custom_reports	Create a custom report
insert_report	POST /datawarehouse/reports	Create a report
update_custom_dashboard	PUT /datawarehouse/custom_dashboards/{custom_dashboard_oid}	Update a custom dashboard
update_custom_dashboard_schedule	PUT /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}	Update a custom dashboard schedule
update_custom_report	PUT /datawarehouse/custom_reports/{custom_report_oid}	Update a custom report
update_custom_report_account_config	PUT /datawarehouse/custom_reports/account_config	Update custom report account config
update_report	PUT /datawarehouse/reports/{report_oid}	Update a report

analyze_custom_report

analyze_custom_report(custom_report_oid, analyze_request)

Analyze a custom report

Analyze a custom report on the UltraCart account.

Examples

(No example for this operation).

Using the analyze_custom_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> analyze_custom_report_with_http_info(custom_report_oid, analyze_request)

begin
  # Analyze a custom report
  data, status_code, headers = api_instance.analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportAnalysisResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->analyze_custom_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_report_oid	Integer	The report oid to analyze.
analyze_request	CustomReportAnalysisRequest	Request to analyze custom report

Return type

CustomReportAnalysisResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

delete_custom_dashboard

delete_custom_dashboard(custom_dashboard_oid)

Delete a custom dashboard

Delete a custom dashboard on the UltraCart account.

Examples

(No example for this operation).

Using the delete_custom_dashboard_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_custom_dashboard_with_http_info(custom_dashboard_oid)

begin
  # Delete a custom dashboard
  data, status_code, headers = api_instance.delete_custom_dashboard_with_http_info(custom_dashboard_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->delete_custom_dashboard_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_dashboard_oid	Integer	The dashboard oid to delete.

Return type

nil (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_custom_dashboard_schedule

delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)

Delete a custom dashboard schedule

delete a custom dashboard schedule on the UltraCart account.

Examples

(No example for this operation).

Using the delete_custom_dashboard_schedule_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)

begin
  # Delete a custom dashboard schedule
  data, status_code, headers = api_instance.delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->delete_custom_dashboard_schedule_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_dashboard_schedule_oid	Integer	The dashboard schedule oid to delete.
custom_dashboard_oid	Integer	The dashboard oid that owns the schedule.

Return type

nil (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_custom_report

delete_custom_report(custom_report_oid)

Delete a custom report

Delete a custom report on the UltraCart account.

Examples

(No example for this operation).

Using the delete_custom_report_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_custom_report_with_http_info(custom_report_oid)

begin
  # Delete a custom report
  data, status_code, headers = api_instance.delete_custom_report_with_http_info(custom_report_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->delete_custom_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_report_oid	Integer	The report oid to delete.

Return type

nil (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_report

delete_report(report_oid)

Delete a report

Delete a report on the UltraCart account.

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the delete_report_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_report_with_http_info(report_oid)

begin
  # Delete a report
  data, status_code, headers = api_instance.delete_report_with_http_info(report_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->delete_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
report_oid	Integer	The report oid to delete.

Return type

nil (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

dry_run_report_queries

dry_run_report_queries(query_request)

Dry run the report queries

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the dry_run_report_queries_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> dry_run_report_queries_with_http_info(query_request)

begin
  # Dry run the report queries
  data, status_code, headers = api_instance.dry_run_report_queries_with_http_info(query_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportDryRunQueriesResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->dry_run_report_queries_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
query_request	ReportDryRunQueriesRequest	Dry run request

Return type

ReportDryRunQueriesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

execute_custom_report

execute_custom_report(custom_report_oid, execution_request)

Execute a custom report

Execute a custom report on the UltraCart account.

Examples

(No example for this operation).

Using the execute_custom_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)

begin
  # Execute a custom report
  data, status_code, headers = api_instance.execute_custom_report_with_http_info(custom_report_oid, execution_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportExecutionResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->execute_custom_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_report_oid	Integer	The report oid to execute.
execution_request	CustomReportExecutionRequest	Request to execute custom report

Return type

CustomReportExecutionResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

execute_custom_reports

execute_custom_reports(execution_request)

Execute a custom reports

Execute a custom reports on the UltraCart account.

Examples

(No example for this operation).

Using the execute_custom_reports_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> execute_custom_reports_with_http_info(execution_request)

begin
  # Execute a custom reports
  data, status_code, headers = api_instance.execute_custom_reports_with_http_info(execution_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportsExecutionResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->execute_custom_reports_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
execution_request	CustomReportsExecutionRequest	Request to execute custom reports

Return type

CustomReportsExecutionResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

execute_report_queries

execute_report_queries(query_request)

Execute the report queries

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the execute_report_queries_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> execute_report_queries_with_http_info(query_request)

begin
  # Execute the report queries
  data, status_code, headers = api_instance.execute_report_queries_with_http_info(query_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->execute_report_queries_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
query_request	ReportExecuteQueriesRequest	Query request

Return type

nil (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

get_custom_dashboard

get_custom_dashboard(custom_dashboard_oid)

Get a custom dashboard

Retrieve a custom dashboard

Examples

(No example for this operation).

Using the get_custom_dashboard_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_dashboard_with_http_info(custom_dashboard_oid)

begin
  # Get a custom dashboard
  data, status_code, headers = api_instance.get_custom_dashboard_with_http_info(custom_dashboard_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomDashboardResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_custom_dashboard_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_dashboard_oid	Integer

Return type

CustomDashboardResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_custom_dashboard_schedules

get_custom_dashboard_schedules(custom_dashboard_oid)

Get custom dashboards

Retrieve a custom dashboards

Examples

(No example for this operation).

Using the get_custom_dashboard_schedules_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)

begin
  # Get custom dashboards
  data, status_code, headers = api_instance.get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomDashboardSchedulesResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_custom_dashboard_schedules_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_dashboard_oid	Integer

Return type

CustomDashboardSchedulesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_custom_dashboards

get_custom_dashboards

Get custom dashboards

Retrieve a custom dashboards

Examples

(No example for this operation).

Using the get_custom_dashboards_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_dashboards_with_http_info

begin
  # Get custom dashboards
  data, status_code, headers = api_instance.get_custom_dashboards_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomDashboardsResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_custom_dashboards_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

CustomDashboardsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_custom_report

get_custom_report(custom_report_oid)

Get a custom report

Retrieve a custom report

Examples

(No example for this operation).

Using the get_custom_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_report_with_http_info(custom_report_oid)

begin
  # Get a custom report
  data, status_code, headers = api_instance.get_custom_report_with_http_info(custom_report_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_custom_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_report_oid	Integer

Return type

CustomReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_custom_report_account_config

get_custom_report_account_config

Get custom report account configuration

Retrieve a custom report account configuration

Examples

(No example for this operation).

Using the get_custom_report_account_config_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_report_account_config_with_http_info

begin
  # Get custom report account configuration
  data, status_code, headers = api_instance.get_custom_report_account_config_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportAccountConfigResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_custom_report_account_config_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

CustomReportAccountConfigResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_custom_report_chart_png_upload_url

get_custom_report_chart_png_upload_url(custom_report_oid)

Upload a PNG of a custom report chart

Examples

(No example for this operation).

Using the get_custom_report_chart_png_upload_url_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)

begin
  # Upload a PNG of a custom report chart
  data, status_code, headers = api_instance.get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportChartPngUploadResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_custom_report_chart_png_upload_url_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_report_oid	Integer	The report oid to upload a chart PNG for.

Return type

CustomReportChartPngUploadResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_custom_reports

get_custom_reports

Get custom reports

Retrieve a custom reports

Examples

(No example for this operation).

Using the get_custom_reports_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_custom_reports_with_http_info

begin
  # Get custom reports
  data, status_code, headers = api_instance.get_custom_reports_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportsResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_custom_reports_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

CustomReportsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_report

get_report(report_oid)

Get a report

Retrieve a report

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the get_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_report_with_http_info(report_oid)

begin
  # Get a report
  data, status_code, headers = api_instance.get_report_with_http_info(report_oid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
report_oid	Integer

Return type

ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_report_data_set

get_report_data_set(dataset_uuid)

Get a report data set

Retrieve a report data set

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the get_report_data_set_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_report_data_set_with_http_info(dataset_uuid)

begin
  # Get a report data set
  data, status_code, headers = api_instance.get_report_data_set_with_http_info(dataset_uuid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportDataSetResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_report_data_set_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
dataset_uuid	String

Return type

ReportDataSetResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_report_data_set_page

get_report_data_set_page(dataset_uuid, page_number)

Get a report data set page

Retrieve a report data set page

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the get_report_data_set_page_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_report_data_set_page_with_http_info(dataset_uuid, page_number)

begin
  # Get a report data set page
  data, status_code, headers = api_instance.get_report_data_set_page_with_http_info(dataset_uuid, page_number)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportDataSetPageResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_report_data_set_page_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
dataset_uuid	String
page_number	Integer

Return type

ReportDataSetPageResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_report_websocket_authorization

get_report_websocket_authorization

Get report websocket authorization

Retrieve a JWT to authorize a report to make a websocket connection.

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the get_report_websocket_authorization_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_report_websocket_authorization_with_http_info

begin
  # Get report websocket authorization
  data, status_code, headers = api_instance.get_report_websocket_authorization_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportAuthResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_report_websocket_authorization_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ReportAuthResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_reports

get_reports

Get list of reports available

Retrieve a list of reports available

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the get_reports_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_reports_with_http_info

begin
  # Get list of reports available
  data, status_code, headers = api_instance.get_reports_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportsResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->get_reports_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ReportsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

insert_custom_dashboard

insert_custom_dashboard(dashboard)

Create a custom dashboard

Create a new custom dashboard on the UltraCart account.

Examples

(No example for this operation).

Using the insert_custom_dashboard_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> insert_custom_dashboard_with_http_info(dashboard)

begin
  # Create a custom dashboard
  data, status_code, headers = api_instance.insert_custom_dashboard_with_http_info(dashboard)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomDashboardResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->insert_custom_dashboard_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
dashboard	CustomDashboard	Dashboard to create

Return type

CustomDashboardResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

insert_custom_dashboard_schedule

insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)

Create a custom dashboard schedule

Create a new custom dashboard schedule on the UltraCart account.

Examples

(No example for this operation).

Using the insert_custom_dashboard_schedule_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)

begin
  # Create a custom dashboard schedule
  data, status_code, headers = api_instance.insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomDashboardScheduleResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->insert_custom_dashboard_schedule_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_dashboard_oid	Integer
dashboard_schedule	CustomDashboardSchedule	Dashboard schedule to create

Return type

CustomDashboardScheduleResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

insert_custom_report

insert_custom_report(report)

Create a custom report

Create a new custom report on the UltraCart account.

Examples

(No example for this operation).

Using the insert_custom_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> insert_custom_report_with_http_info(report)

begin
  # Create a custom report
  data, status_code, headers = api_instance.insert_custom_report_with_http_info(report)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->insert_custom_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
report	CustomReport	Report to create

Return type

CustomReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

insert_report

insert_report(report)

Create a report

Create a new report on the UltraCart account.

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the insert_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> insert_report_with_http_info(report)

begin
  # Create a report
  data, status_code, headers = api_instance.insert_report_with_http_info(report)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->insert_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
report	Report	Report to create

Return type

ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

update_custom_dashboard

update_custom_dashboard(custom_dashboard_oid, dashboard)

Update a custom dashboard

Update a custom dashboard on the UltraCart account.

Examples

(No example for this operation).

Using the update_custom_dashboard_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)

begin
  # Update a custom dashboard
  data, status_code, headers = api_instance.update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomDashboardResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->update_custom_dashboard_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_dashboard_oid	Integer	The dashboard oid to custom update.
dashboard	CustomDashboard	Dashboard to custom update

Return type

CustomDashboardResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

update_custom_dashboard_schedule

update_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)

Update a custom dashboard schedule

Update a custom dashboard schedule on the UltraCart account.

Examples

(No example for this operation).

Using the update_custom_dashboard_schedule_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)

begin
  # Update a custom dashboard schedule
  data, status_code, headers = api_instance.update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomDashboardResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->update_custom_dashboard_schedule_with_http_info: #{e}"
end

Parameters

Name	Type	Description
custom_dashboard_schedule_oid	Integer	The dashboard schedule oid to update.
custom_dashboard_oid	Integer	The dashboard oid to update.
dashboard_schedule	CustomDashboardSchedule	Dashboard schedule to update

Return type

CustomDashboardResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

update_custom_report

update_custom_report(custom_report_oid, report)

Update a custom report

Update a custom report on the UltraCart account.

Examples

(No example for this operation).

Using the update_custom_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_custom_report_with_http_info(custom_report_oid, report)

begin
  # Update a custom report
  data, status_code, headers = api_instance.update_custom_report_with_http_info(custom_report_oid, report)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->update_custom_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
custom_report_oid	Integer	The report oid to custom update.
report	CustomReport	Report to custom update

Return type

CustomReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

update_custom_report_account_config

update_custom_report_account_config(account_config)

Update custom report account config

Update custom report account config.

Examples

(No example for this operation).

Using the update_custom_report_account_config_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_custom_report_account_config_with_http_info(account_config)

begin
  # Update custom report account config
  data, status_code, headers = api_instance.update_custom_report_account_config_with_http_info(account_config)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomReportAccountConfigResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->update_custom_report_account_config_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_config	CustomReportAccountConfig	Account config to update

Return type

CustomReportAccountConfigResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

update_report

update_report(report_oid, report)

Update a report

Update a report on the UltraCart account.

Examples

# Internal API.  No samples are provided as merchants will never need this api method

Using the update_report_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_report_with_http_info(report_oid, report)

begin
  # Update a report
  data, status_code, headers = api_instance.update_report_with_http_info(report_oid, report)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReportResponse>
rescue UltracartClient::ApiError => e
  puts "Error when calling DatawarehouseApi->update_report_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
report_oid	Integer	The report oid to update.
report	Report	Report to update

Return type

ReportResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

Uh oh!

FilesExpand file tree

DatawarehouseApi.md

Latest commit

History

DatawarehouseApi.md

File metadata and controls

UltracartClient::DatawarehouseApi

analyze_custom_report

Examples

Using the analyze_custom_report_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_custom_dashboard

Examples

Using the delete_custom_dashboard_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_custom_dashboard_schedule

Examples

Using the delete_custom_dashboard_schedule_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_custom_report

Examples

Using the delete_custom_report_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_report

Examples

Using the delete_report_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

dry_run_report_queries

Examples

Using the dry_run_report_queries_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

execute_custom_report

Examples

Using the execute_custom_report_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

execute_custom_reports

Examples

Using the execute_custom_reports_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

execute_report_queries

Examples

Using the execute_report_queries_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_custom_dashboard

Examples

Using the get_custom_dashboard_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_custom_dashboard_schedules

Examples