diff --git a/src/pages/management/changelog/index.mdx b/src/pages/management/changelog/index.mdx index 1734ab510..85c1a9253 100644 --- a/src/pages/management/changelog/index.mdx +++ b/src/pages/management/changelog/index.mdx @@ -37,6 +37,10 @@ The developer preview version provides a preview of the upcoming changes to the - [**List Canned Responses**](/management/configuration-api/v3.7#list-canned-responses) - [**Delete Canned Response**](/management/configuration-api/v3.7#delete-canned-response) +### Greetings + +- There is a new greeting rule type in the [**Create Greeting**](/management/configuration-api/v3.7#create-greeting) method: `url_match_page_view_number`. + ### Translations - Added translations management methods: diff --git a/src/pages/management/configuration-api/index.mdx b/src/pages/management/configuration-api/index.mdx index 3fe07a0b1..f8daf8145 100644 --- a/src/pages/management/configuration-api/index.mdx +++ b/src/pages/management/configuration-api/index.mdx @@ -2008,8 +2008,8 @@ Creates a new greeting. | `rules[].type`**1** | Yes | `string` | The type of the rule condition. | | `rules[].operator`**2** | Yes | `string` | The comparison operator for the rule. Not required for `url_funnel`**1**, `custom_variable`**1**, and `ads_traffic`**1**. | | `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`**2**. Required for most rule types. | -| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`**1** type. Maximum: 10 objects. | -| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`**1** rule. Required when `urls` array is used. | +| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`**1** and `url_match_page_view_number`**1** types. Maximum: 10 objects. | +| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`**1** and `url_match_page_view_number`**1** rules. Required when the `urls` array is used. | | `rules[].urls[].operator`**2** | No | `string` | The operator for the URL comparison. Required when `urls` array is used. | | `rules[].session_field` | No | `object` | Key-value pairs. Required for `custom_variable`**1** and `ads_traffic`**1** types - exactly one element. | | `properties`**3** | No | `object` | The additional properties for the greeting as key-value pairs. | @@ -2017,20 +2017,21 @@ Creates a new greeting. **1)** Parameter requirements for each `rules[].type` value: -| Type value | Required Parameters | Parameter Details | -| ------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `visit_time_site` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the entire website). | -| `visit_time_page` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the current page). | -| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. | -| `url_visited` | `value`, `operator` | The `value` contains the previously visited URL to match. | -| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. | -| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. | -| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. | -| `geolocation` | `value`, `operator` | The `value` contains the geographic location to match. | -| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. | -| `search_keyword` | `value`, `operator` | The `value` contains the search keyword to match. | -| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. | -| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. Value maximum: 255 characters. | +| Type value | Required Parameters | Parameter Details | +| ----------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `visit_time_site` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the entire website). | +| `visit_time_page` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the current page). | +| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. | +| `url_visited` | `value`, `operator` | The `value` contains the previously visited URL to match. | +| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. | +| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. | +| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. | +| `geolocation` | `value`, `operator` | The `value` contains the geographic location to match. | +| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. | +| `search_keyword` | `value`, `operator` | The `value` contains the search keyword to match. | +| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. | +| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. Value maximum: 255 characters. | +| `url_match_page_view_number` | `value`, `operator`, `urls` | The `value` contains the number of pages viewed to compare. The `urls` is an array with 1-10 URL objects, each with `url` and `operator`. The rule matches if any of the `urls` match the `value`. | **2)** Possible values for the `rules[].operator` and `rules[].urls[].operator` parameters: @@ -4389,4 +4390,4 @@ curl -X POST \ # Contact us -If you found a bug or a typo, you can let us know directly on GitHub. In case of any questions or feedback, don't hesitate to contact us at developers@text.com. We'll be happy to hear from you! \ No newline at end of file +If you found a bug or a typo, you can let us know directly on GitHub. In case of any questions or feedback, don't hesitate to contact us at developers@text.com. We'll be happy to hear from you! diff --git a/src/pages/management/configuration-api/v3.7/index.mdx b/src/pages/management/configuration-api/v3.7/index.mdx index 2b002c509..402e6b4d0 100644 --- a/src/pages/management/configuration-api/v3.7/index.mdx +++ b/src/pages/management/configuration-api/v3.7/index.mdx @@ -2169,8 +2169,8 @@ Creates a new greeting. | `rules[].type`**1** | Yes | `string` | The type of the rule condition. | | `rules[].operator`**2** | Yes | `string` | The comparison operator for the rule. Not required for `url_funnel`**1**, `custom_variable`**1**, and `ads_traffic`**1**. | | `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`**2**. Required for most rule types. | -| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`**1** type. Accepts up to 10 objects. | -| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`**1** rule. Required when `urls` array is used. | +| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`**1** and `url_match_page_view_number`**1** types. Maximum: 10 objects. | +| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`**1** and `url_match_page_view_number`**1** rules. Required when the `urls` array is used. | | `rules[].urls[].operator`**2** | No | `string` | The operator for the URL comparison. Required when `urls` array is used. | | `rules[].session_field` | No | `object` | Key-value pairs. Required for `custom_variable`**1** and `ads_traffic`**1** types - exactly one element. | | `properties`**3** | No | `object` | Additional properties for the greeting as key-value pairs. | @@ -2178,20 +2178,21 @@ Creates a new greeting. **1)** Parameter requirements for each `rules[].type` value: -| Type value | Required Parameters | Parameter Details | -| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `visit_time_site` | `value`, `operator` | The `value` must be an integer 0-900 (seconds spent on the entire website). | -| `visit_time_page` | `value`, `operator` | The `value` must be an integer 0-900 (seconds spent on the current page). | -| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. | -| `url_visited` | `value`, `operator` | The `value` contains a previously visited URL to match. | -| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. | -| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. | -| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. | -| `geolocation` | `value`, `operator` | The `value` contains a geographic location to match. | -| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. | -| `search_keyword` | `value`, `operator` | The `value` contains a search keyword to match. | -| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. | -| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. The value maximum: 255 characters. | +| Type value | Required Parameters | Parameter Details | +| ----------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------| +| `visit_time_site` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the entire website). | +| `visit_time_page` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the current page). | +| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. | +| `url_visited` | `value`, `operator` | The `value` contains the previously visited URL to match. | +| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. | +| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. | +| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. | +| `geolocation` | `value`, `operator` | The `value` contains the geographic location to match. | +| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. | +| `search_keyword` | `value`, `operator` | The `value` contains the search keyword to match. | +| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. | +| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. Value maximum: 255 characters. | +| `url_match_page_view_number` | `value`, `operator`, `urls` | The `value` contains the number of pages viewed to compare. The `urls` is an array with 1-10 URL objects, each with `url` and `operator`. The rule matches if any of the `urls` match the `value`. | **2)** Possible values for the `rules[].operator` and `rules[].urls[].operator` parameters: