docs/SegmentsApi.md in klaviyo-api-sdk-4.1.0 vs docs/SegmentsApi.md in klaviyo-api-sdk-4.2.0
- old
+ new
@@ -17,11 +17,11 @@
> Hash<String, Object> get_segment(id, opts)
Get Segment
-Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-08-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read`
+Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-09-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read`
### Examples
```ruby
require 'time'
@@ -36,13 +36,13 @@
api_instance = KlaviyoAPI::SegmentsApi.new
id = 'id_example' # String |
opts = {
additional_fields_segment: ['profile_count'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'profile_count'
- fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
- include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
+ fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
+ include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
}
begin
# Get Segment
result = api_instance.get_segment(id, opts)
@@ -74,13 +74,13 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | | |
| **additional_fields_segment** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'profile_count' | [optional] |
-| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
+| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
### Return type
**Hash<String, Object>**
@@ -98,11 +98,11 @@
> Hash<String, Object> get_segment_profiles(id, opts)
Get Segment Profiles
-Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
+Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
### Examples
```ruby
require 'time'
@@ -117,14 +117,15 @@
api_instance = KlaviyoAPI::SegmentsApi.new
id = 'id_example' # String |
opts = {
additional_fields_profile: ['predictive_analytics'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
- fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
- page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
+ page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
+ sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
}
begin
# Get Segment Profiles
result = api_instance.get_segment_profiles(id, opts)
@@ -156,14 +157,15 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | | |
| **additional_fields_profile** | [**Array<String>**](String.md) | Request additional fields not included by default in the response. Supported values: 'predictive_analytics' | [optional] |
-| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals` | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
+| **fields_profile** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
### Return type
**Hash<String, Object>**
@@ -199,11 +201,14 @@
end
api_instance = KlaviyoAPI::SegmentsApi.new
id = 'id_example' # String |
opts = {
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
+ page_size: 56, # Integer | Default: 20. Min: 1. Max: 1000.
+ sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
}
begin
# Get Segment Relationships Profiles
result = api_instance.get_segment_relationships_profiles(id, opts)
@@ -234,11 +239,14 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | | |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
+| **page_size** | **Integer** | Default: 20. Min: 1. Max: 1000. | [optional][default to 20] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
### Return type
**Hash<String, Object>**
@@ -345,11 +353,11 @@
end
api_instance = KlaviyoAPI::SegmentsApi.new
id = 'id_example' # String |
opts = {
- fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
}
begin
# Get Segment Tags
result = api_instance.get_segment_tags(id, opts)
@@ -380,11 +388,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | | |
-| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
### Return type
**Hash<String, Object>**
@@ -419,15 +427,15 @@
# config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
end
api_instance = KlaviyoAPI::SegmentsApi.new
opts = {
- fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
- include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
+ fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
+ include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
}
begin
# Get Segments
result = api_instance.get_segments(opts)
@@ -457,14 +465,14 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` | [optional] |
-| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
+| **fields_segment** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` | [optional] |
+| **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
### Return type
**Hash<String, Object>**