docs/ReportingApi.md in klaviyo-api-sdk-6.0.0 vs docs/ReportingApi.md in klaviyo-api-sdk-7.1.0
- old
+ new
@@ -29,13 +29,13 @@
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
end
api_instance = KlaviyoAPI::ReportingApi.new
-campaign_values_request_dto = KlaviyoAPI::CampaignValuesRequestDTO.new({data: KlaviyoAPI::CampaignValuesRequestDTOResourceObject.new({type: KlaviyoAPI::CampaignValuesReportEnum::CAMPAIGN_VALUES_REPORT, attributes: KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.now, _end: Time.now}), conversion_metric_id: 'RESQ6t'})})}) # CampaignValuesRequestDTO |
+campaign_values_request_dto = KlaviyoAPI::CampaignValuesRequestDTO.new({data: KlaviyoAPI::CampaignValuesRequestDTOResourceObject.new({type: KlaviyoAPI::CampaignValuesReportEnum::CAMPAIGN_VALUES_REPORT, attributes: KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.parse('2022-11-08T00:00Z'), _end: Time.parse('2022-11-08T00:00Z')}), conversion_metric_id: 'RESQ6t'})})}) # CampaignValuesRequestDTO |
opts = {
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
}
begin
# Query Campaign Values
result = api_instance.query_campaign_values(campaign_values_request_dto, opts)
@@ -66,11 +66,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **campaign_values_request_dto** | [**CampaignValuesRequestDTO**](CampaignValuesRequestDTO.md) | | |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | [optional] |
### Return type
**Hash<String, Object>**
@@ -104,13 +104,13 @@
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
end
api_instance = KlaviyoAPI::ReportingApi.new
-flow_series_request_dto = KlaviyoAPI::FlowSeriesRequestDTO.new({data: KlaviyoAPI::FlowSeriesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowSeriesReportEnum::FLOW_SERIES_REPORT, attributes: KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.now, _end: Time.now}), interval: 'daily', conversion_metric_id: 'RESQ6t'})})}) # FlowSeriesRequestDTO |
+flow_series_request_dto = KlaviyoAPI::FlowSeriesRequestDTO.new({data: KlaviyoAPI::FlowSeriesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowSeriesReportEnum::FLOW_SERIES_REPORT, attributes: KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.parse('2022-11-08T00:00Z'), _end: Time.parse('2022-11-08T00:00Z')}), interval: 'daily', conversion_metric_id: 'RESQ6t'})})}) # FlowSeriesRequestDTO |
opts = {
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
}
begin
# Query Flow Series
result = api_instance.query_flow_series(flow_series_request_dto, opts)
@@ -141,11 +141,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **flow_series_request_dto** | [**FlowSeriesRequestDTO**](FlowSeriesRequestDTO.md) | | |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | [optional] |
### Return type
**Hash<String, Object>**
@@ -179,13 +179,13 @@
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
end
api_instance = KlaviyoAPI::ReportingApi.new
-flow_values_request_dto = KlaviyoAPI::FlowValuesRequestDTO.new({data: KlaviyoAPI::FlowValuesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowValuesReportEnum::FLOW_VALUES_REPORT, attributes: KlaviyoAPI::FlowValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.now, _end: Time.now}), conversion_metric_id: 'RESQ6t'})})}) # FlowValuesRequestDTO |
+flow_values_request_dto = KlaviyoAPI::FlowValuesRequestDTO.new({data: KlaviyoAPI::FlowValuesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowValuesReportEnum::FLOW_VALUES_REPORT, attributes: KlaviyoAPI::FlowValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.parse('2022-11-08T00:00Z'), _end: Time.parse('2022-11-08T00:00Z')}), conversion_metric_id: 'RESQ6t'})})}) # FlowValuesRequestDTO |
opts = {
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
}
begin
# Query Flow Values
result = api_instance.query_flow_values(flow_values_request_dto, opts)
@@ -216,10 +216,10 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **flow_values_request_dto** | [**FlowValuesRequestDTO**](FlowValuesRequestDTO.md) | | |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | [optional] |
### Return type
**Hash<String, Object>**