Skip to content

Commit 12c0dcb

Browse files
mdojwamdojwa
authored
feat(docs): new 'url_match_page_view_number' greeting trigger (#1649)
1 parent 4aebd2b commit 12c0dcb

3 files changed

Lines changed: 39 additions & 33 deletions

File tree

‎src/pages/management/changelog/index.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ The developer preview version provides a preview of the upcoming changes to the
3737
- [**List Canned Responses**](/management/configuration-api/v3.7#list-canned-responses)
3838
- [**Delete Canned Response**](/management/configuration-api/v3.7#delete-canned-response)
3939

40+
### Greetings
41+
42+
- There is a new greeting rule type in the [**Create Greeting**](/management/configuration-api/v3.7#create-greeting) method: `url_match_page_view_number`.
43+
4044
### Translations
4145

4246
- Added translations management methods:

‎src/pages/management/configuration-api/index.mdx‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2008,29 +2008,30 @@ Creates a new greeting.
20082008
| `rules[].type`<sup>**1**</sup> | Yes | `string` | The type of the rule condition. |
20092009
| `rules[].operator`<sup>**2**</sup> | Yes | `string` | The comparison operator for the rule. Not required for `url_funnel`<sup>**1**</sup>, `custom_variable`<sup>**1**</sup>, and `ads_traffic`<sup>**1**</sup>. |
20102010
| `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`<sup>**2**</sup>. Required for most rule types. |
2011-
| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`<sup>**1**</sup> type. Maximum: 10 objects. |
2012-
| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`<sup>**1**</sup> rule. Required when `urls` array is used. |
2011+
| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`<sup>**1**</sup> and `url_match_page_view_number`<sup>**1**</sup> types. Maximum: 10 objects. |
2012+
| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`<sup>**1**</sup> and `url_match_page_view_number`<sup>**1**</sup> rules. Required when the `urls` array is used. |
20132013
| `rules[].urls[].operator`<sup>**2**</sup> | No | `string` | The operator for the URL comparison. Required when `urls` array is used. |
20142014
| `rules[].session_field` | No | `object` | Key-value pairs. Required for `custom_variable`<sup>**1**</sup> and `ads_traffic`<sup>**1**</sup> types - exactly one element. |
20152015
| `properties`<sup>**3**</sup> | No | `object` | The additional properties for the greeting as key-value pairs. |
20162016
| `rich_message`<sup>**4**</sup> | No | `object` | The rich message content of the greeting. |
20172017

20182018
**1)** Parameter requirements for each `rules[].type` value:
20192019

2020-
| Type value | Required Parameters | Parameter Details |
2021-
| ------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
2022-
| `visit_time_site` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the entire website). |
2023-
| `visit_time_page` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the current page). |
2024-
| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. |
2025-
| `url_visited` | `value`, `operator` | The `value` contains the previously visited URL to match. |
2026-
| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. |
2027-
| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. |
2028-
| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. |
2029-
| `geolocation` | `value`, `operator` | The `value` contains the geographic location to match. |
2030-
| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. |
2031-
| `search_keyword` | `value`, `operator` | The `value` contains the search keyword to match. |
2032-
| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. |
2033-
| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. Value maximum: 255 characters. |
2020+
| Type value | Required Parameters | Parameter Details |
2021+
| ----------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2022+
| `visit_time_site` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the entire website). |
2023+
| `visit_time_page` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the current page). |
2024+
| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. |
2025+
| `url_visited` | `value`, `operator` | The `value` contains the previously visited URL to match. |
2026+
| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. |
2027+
| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. |
2028+
| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. |
2029+
| `geolocation` | `value`, `operator` | The `value` contains the geographic location to match. |
2030+
| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. |
2031+
| `search_keyword` | `value`, `operator` | The `value` contains the search keyword to match. |
2032+
| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. |
2033+
| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. Value maximum: 255 characters. |
2034+
| `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`. |
20342035

20352036
**2)** Possible values for the `rules[].operator` and `rules[].urls[].operator` parameters:
20362037

@@ -4389,4 +4390,4 @@ curl -X POST \
43894390

43904391
# Contact us
43914392

4392-
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 <a href="mailto:developers@text.com">developers@text.com</a>. We'll be happy to hear from you!
4393+
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 <a href="mailto:developers@text.com">developers@text.com</a>. We'll be happy to hear from you!

‎src/pages/management/configuration-api/v3.7/index.mdx‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2169,29 +2169,30 @@ Creates a new greeting.
21692169
| `rules[].type`<sup>**1**</sup> | Yes | `string` | The type of the rule condition. |
21702170
| `rules[].operator`<sup>**2**</sup> | Yes | `string` | The comparison operator for the rule. Not required for `url_funnel`<sup>**1**</sup>, `custom_variable`<sup>**1**</sup>, and `ads_traffic`<sup>**1**</sup>. |
21712171
| `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`<sup>**2**</sup>. Required for most rule types. |
2172-
| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`<sup>**1**</sup> type. Accepts up to 10 objects. |
2173-
| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`<sup>**1**</sup> rule. Required when `urls` array is used. |
2172+
| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`<sup>**1**</sup> and `url_match_page_view_number`<sup>**1**</sup> types. Maximum: 10 objects. |
2173+
| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`<sup>**1**</sup> and `url_match_page_view_number`<sup>**1**</sup> rules. Required when the `urls` array is used. |
21742174
| `rules[].urls[].operator`<sup>**2**</sup> | No | `string` | The operator for the URL comparison. Required when `urls` array is used. |
21752175
| `rules[].session_field` | No | `object` | Key-value pairs. Required for `custom_variable`<sup>**1**</sup> and `ads_traffic`<sup>**1**</sup> types - exactly one element. |
21762176
| `properties`<sup>**3**</sup> | No | `object` | Additional properties for the greeting as key-value pairs. |
21772177
| `rich_message`<sup>**4**</sup> | No | `object` | The rich message content of the greeting. |
21782178

21792179
**1)** Parameter requirements for each `rules[].type` value:
21802180

2181-
| Type value | Required Parameters | Parameter Details |
2182-
| ------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
2183-
| `visit_time_site` | `value`, `operator` | The `value` must be an integer 0-900 (seconds spent on the entire website). |
2184-
| `visit_time_page` | `value`, `operator` | The `value` must be an integer 0-900 (seconds spent on the current page). |
2185-
| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. |
2186-
| `url_visited` | `value`, `operator` | The `value` contains a previously visited URL to match. |
2187-
| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. |
2188-
| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. |
2189-
| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. |
2190-
| `geolocation` | `value`, `operator` | The `value` contains a geographic location to match. |
2191-
| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. |
2192-
| `search_keyword` | `value`, `operator` | The `value` contains a search keyword to match. |
2193-
| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. |
2194-
| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. The value maximum: 255 characters. |
2181+
| Type value | Required Parameters | Parameter Details |
2182+
| ----------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------|
2183+
| `visit_time_site` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the entire website). |
2184+
| `visit_time_page` | `value`, `operator` | The `value` must be an integer between 0 and 900 (seconds spent on the current page). |
2185+
| `url_current` | `value`, `operator` | The `value` contains the current page URL to match. |
2186+
| `url_visited` | `value`, `operator` | The `value` contains the previously visited URL to match. |
2187+
| `url_funnel` | `urls` | The `urls` array with 1-10 URL objects, each with `url` and `operator`. |
2188+
| `pages_view_number` | `value`, `operator` | The `value` contains the number of pages viewed to compare. |
2189+
| `url_referrer` | `value`, `operator` | The `value` contains the referrer URL to match. |
2190+
| `geolocation` | `value`, `operator` | The `value` contains the geographic location to match. |
2191+
| `visits_number` | `value`, `operator` | The `value` contains the number of visits to compare. |
2192+
| `search_keyword` | `value`, `operator` | The `value` contains the search keyword to match. |
2193+
| `custom_variable` | `session_field` | The `session_field` object with exactly one key-value pair. Maximum: 255 characters each. |
2194+
| `ads_traffic` | `session_field` | The `session_field` with one key from: `microsoft`, `facebook`, `google`, `twitter`, `yahoo`. Value maximum: 255 characters. |
2195+
| `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`. |
21952196

21962197
**2)** Possible values for the `rules[].operator` and `rules[].urls[].operator` parameters:
21972198

0 commit comments

Comments
 (0)