Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/pages/management/changelog/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
35 changes: 18 additions & 17 deletions src/pages/management/configuration-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2008,29 +2008,30 @@ Creates a new greeting.
| `rules[].type`<sup>**1**</sup> | Yes | `string` | The type of the rule condition. |
| `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>. |
| `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`<sup>**2**</sup>. Required for most rule types. |
| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`<sup>**1**</sup> type. Maximum: 10 objects. |
| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`<sup>**1**</sup> rule. Required when `urls` array is used. |
| `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. |
| `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. |
| `rules[].urls[].operator`<sup>**2**</sup> | 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`<sup>**1**</sup> and `ads_traffic`<sup>**1**</sup> types - exactly one element. |
| `properties`<sup>**3**</sup> | No | `object` | The additional properties for the greeting as key-value pairs. |
| `rich_message`<sup>**4**</sup> | No | `object` | The rich message content of the 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` in an array with 1-10 URL objects, each with `url` and `operator`. The rule matches if any of the `urls` matches. |

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

Expand Down Expand Up @@ -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 <a href="mailto:developers@text.com">developers@text.com</a>. We'll be happy to hear from you!
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!
33 changes: 17 additions & 16 deletions src/pages/management/configuration-api/v3.7/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2169,29 +2169,30 @@ Creates a new greeting.
| `rules[].type`<sup>**1**</sup> | Yes | `string` | The type of the rule condition. |
| `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>. |
| `rules[].value` | No | `string` | The value to compare against, based on the selected `operator`<sup>**2**</sup>. Required for most rule types. |
| `rules[].urls` | No | `object[]` | An array of URLs. Required only for the `url_funnel`<sup>**1**</sup> type. Accepts up to 10 objects. |
| `rules[].urls[].url` | No | `string` | The URL for the `url_funnel`<sup>**1**</sup> rule. Required when `urls` array is used. |
| `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. |
| `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. |
| `rules[].urls[].operator`<sup>**2**</sup> | 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`<sup>**1**</sup> and `ads_traffic`<sup>**1**</sup> types - exactly one element. |
| `properties`<sup>**3**</sup> | No | `object` | Additional properties for the greeting as key-value pairs. |
| `rich_message`<sup>**4**</sup> | No | `object` | The rich message content of the 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` in an array with 1-10 URL objects, each with `url` and `operator`. The rule matches if any of the `urls` matches. |

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

Expand Down
Loading