Sha256: 87ea3f8debde4d8fae6b927e169d0a78b605bdf157b7e8af43f09d4d11254624

Contents?: true

Size: 1.79 KB

Versions: 36

Compression:

Stored size: 1.79 KB

Contents

# UltracartClient::ReportDataSetQuery

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **comparison_results** | **Boolean** | True if a date range filter is provided with comparison date ranges and two results should be returned for the query. | [optional] |
| **data_set_query_uuid** | **String** | A unique identifier assigned to the data set query that is returned. | [optional] |
| **data_source** | [**ReportDataSource**](ReportDataSource.md) |  | [optional] |
| **dimensions** | [**Array<ReportPageVisualizationDimension>**](ReportPageVisualizationDimension.md) |  | [optional] |
| **filter** | [**ReportFilter**](ReportFilter.md) |  | [optional] |
| **for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional] |
| **for_object_type** | **String** | The type of object this data set is for | [optional] |
| **metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) |  | [optional] |
| **page_size** | **Integer** | Result set page size.  The default value is 200 records.  Max is 10000. | [optional] |
| **selected_filters** | [**Array<ReportFilter>**](ReportFilter.md) |  | [optional] |
| **skip_cache** | **Boolean** | True if the 15 minute cache should be skipped. | [optional] |
| **user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional] |

## Example

```ruby
require 'ultracart_api'

instance = UltracartClient::ReportDataSetQuery.new(
  comparison_results: null,
  data_set_query_uuid: null,
  data_source: null,
  dimensions: null,
  filter: null,
  for_object_id: null,
  for_object_type: null,
  metrics: null,
  page_size: null,
  selected_filters: null,
  skip_cache: null,
  user_data: null
)
```

Version data entries

36 entries across 36 versions & 1 rubygems

Version Path
ultracart_api-4.0.157 docs/ReportDataSetQuery.md
ultracart_api-4.0.156 docs/ReportDataSetQuery.md
ultracart_api-4.0.155 docs/ReportDataSetQuery.md
ultracart_api-4.0.154 docs/ReportDataSetQuery.md
ultracart_api-4.0.153 docs/ReportDataSetQuery.md
ultracart_api-4.0.152 docs/ReportDataSetQuery.md
ultracart_api-4.0.151 docs/ReportDataSetQuery.md
ultracart_api-4.0.150 docs/ReportDataSetQuery.md
ultracart_api-4.0.149 docs/ReportDataSetQuery.md
ultracart_api-4.0.148 docs/ReportDataSetQuery.md
ultracart_api-4.0.147 docs/ReportDataSetQuery.md
ultracart_api-4.0.146 docs/ReportDataSetQuery.md
ultracart_api-4.0.145 docs/ReportDataSetQuery.md
ultracart_api-4.0.144 docs/ReportDataSetQuery.md
ultracart_api-4.0.143 docs/ReportDataSetQuery.md
ultracart_api-4.0.142 docs/ReportDataSetQuery.md